From 6d830b0bf7136396a0bbbfcca085a4d25f77d2a5 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 30 Sep 2025 07:09:33 +0000 Subject: [PATCH 01/42] feat(aiplatform): update the api #### aiplatform:v1 The following keys were added: - schemas.GoogleCloudAiplatformV1AutoraterConfig.properties.generationConfig.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1LustreMount (Total Keys: 6) - schemas.GoogleCloudAiplatformV1WorkerPoolSpec.properties.lustreMounts (Total Keys: 2) #### aiplatform:v1beta1 The following keys were added: - schemas.GoogleCloudAiplatformV1beta1AutoraterConfig.properties.generationConfig.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1LustreMount (Total Keys: 6) - schemas.GoogleCloudAiplatformV1beta1SandboxEnvironment.properties.expireTime (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1SandboxEnvironment.properties.ttl (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1WorkerPoolSpec.properties.lustreMounts (Total Keys: 2) --- docs/dyn/aiplatform_v1.endpoints.html | 18 +- ..._v1.projects.locations.cachedContents.html | 24 +- ...form_v1.projects.locations.customJobs.html | 32 + ...tform_v1.projects.locations.endpoints.html | 18 +- ...v1.projects.locations.evaluationItems.html | 24 +- ..._v1.projects.locations.evaluationRuns.html | 8 +- .../dyn/aiplatform_v1.projects.locations.html | 598 +++- ...ts.locations.hyperparameterTuningJobs.html | 32 + ...latform_v1.projects.locations.nasJobs.html | 64 + ....projects.locations.publishers.models.html | 18 +- ...form_v1.projects.locations.tuningJobs.html | 10 +- docs/dyn/aiplatform_v1.publishers.models.html | 18 +- docs/dyn/aiplatform_v1beta1.endpoints.html | 18 +- ...ta1.projects.locations.cachedContents.html | 24 +- ...v1beta1.projects.locations.customJobs.html | 32 + ...m_v1beta1.projects.locations.datasets.html | 8 +- ..._v1beta1.projects.locations.endpoints.html | 18 +- ...a1.projects.locations.evaluationItems.html | 24 +- ...ta1.projects.locations.evaluationRuns.html | 8 +- ...eta1.projects.locations.exampleStores.html | 18 +- ...v1beta1.projects.locations.extensions.html | 4 +- ...aiplatform_v1beta1.projects.locations.html | 619 +++- ...ts.locations.hyperparameterTuningJobs.html | 32 + ...rm_v1beta1.projects.locations.nasJobs.html | 64 + ....projects.locations.publishers.models.html | 18 +- ...1.projects.locations.reasoningEngines.html | 8 +- ...s.locations.reasoningEngines.memories.html | 2 +- ....reasoningEngines.sandboxEnvironments.html | 6 + ...ions.reasoningEngines.sessions.events.html | 2 +- ...s.locations.reasoningEngines.sessions.html | 2 +- ...v1beta1.projects.locations.tuningJobs.html | 2594 ++++++++++++++++- .../aiplatform_v1beta1.publishers.models.html | 18 +- .../aiplatform_v1beta1.reasoningEngines.html | 8 +- ...orm_v1beta1.reasoningEngines.memories.html | 2 +- ...eta1.reasoningEngines.sessions.events.html | 2 +- ...orm_v1beta1.reasoningEngines.sessions.html | 2 +- .../documents/aiplatform.v1.json | 45 +- .../documents/aiplatform.v1beta1.json | 55 +- 38 files changed, 4281 insertions(+), 216 deletions(-) diff --git a/docs/dyn/aiplatform_v1.endpoints.html b/docs/dyn/aiplatform_v1.endpoints.html index 07021899ba8..5deef6364b8 100644 --- a/docs/dyn/aiplatform_v1.endpoints.html +++ b/docs/dyn/aiplatform_v1.endpoints.html @@ -140,7 +140,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -226,7 +226,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -358,7 +358,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -675,7 +675,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -817,7 +817,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -1103,7 +1103,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -1411,7 +1411,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -1553,7 +1553,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -1839,7 +1839,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. diff --git a/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html b/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html index 41d0c92487d..72d31963c12 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html +++ b/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html @@ -132,7 +132,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -186,7 +186,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -463,7 +463,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -517,7 +517,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -819,7 +819,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -873,7 +873,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -1161,7 +1161,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -1215,7 +1215,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -1511,7 +1511,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -1565,7 +1565,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -1843,7 +1843,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -1897,7 +1897,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. diff --git a/docs/dyn/aiplatform_v1.projects.locations.customJobs.html b/docs/dyn/aiplatform_v1.projects.locations.customJobs.html index 4074c095e4d..0a2e708e106 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.customJobs.html +++ b/docs/dyn/aiplatform_v1.projects.locations.customJobs.html @@ -212,6 +212,14 @@

Method Details

"bootDiskSizeGb": 42, # Size in GB of the boot disk (default is 100GB). "bootDiskType": "A String", # Type of the boot disk. For non-A3U machines, the default value is "pd-ssd", for A3U machines, the default value is "hyperdisk-balanced". Valid values: "pd-ssd" (Persistent Disk Solid State Drive), "pd-standard" (Persistent Disk Hard Disk Drive) or "hyperdisk-balanced". }, + "lustreMounts": [ # Optional. List of Lustre mounts. + { # Represents a mount configuration for Lustre file system. + "filesystem": "A String", # Required. The name of the Lustre filesystem. + "instanceIp": "A String", # Required. IP address of the Lustre instance. + "mountPoint": "A String", # Required. Destination mount path. The Lustre file system will be mounted for the user under /mnt/lustre/ + "volumeHandle": "A String", # Required. The unique identifier of the Lustre volume. + }, + ], "machineSpec": { # Specification of a single machine. # Optional. Immutable. The specification of a single machine. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. @@ -347,6 +355,14 @@

Method Details

"bootDiskSizeGb": 42, # Size in GB of the boot disk (default is 100GB). "bootDiskType": "A String", # Type of the boot disk. For non-A3U machines, the default value is "pd-ssd", for A3U machines, the default value is "hyperdisk-balanced". Valid values: "pd-ssd" (Persistent Disk Solid State Drive), "pd-standard" (Persistent Disk Hard Disk Drive) or "hyperdisk-balanced". }, + "lustreMounts": [ # Optional. List of Lustre mounts. + { # Represents a mount configuration for Lustre file system. + "filesystem": "A String", # Required. The name of the Lustre filesystem. + "instanceIp": "A String", # Required. IP address of the Lustre instance. + "mountPoint": "A String", # Required. Destination mount path. The Lustre file system will be mounted for the user under /mnt/lustre/ + "volumeHandle": "A String", # Required. The unique identifier of the Lustre volume. + }, + ], "machineSpec": { # Specification of a single machine. # Optional. Immutable. The specification of a single machine. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. @@ -524,6 +540,14 @@

Method Details

"bootDiskSizeGb": 42, # Size in GB of the boot disk (default is 100GB). "bootDiskType": "A String", # Type of the boot disk. For non-A3U machines, the default value is "pd-ssd", for A3U machines, the default value is "hyperdisk-balanced". Valid values: "pd-ssd" (Persistent Disk Solid State Drive), "pd-standard" (Persistent Disk Hard Disk Drive) or "hyperdisk-balanced". }, + "lustreMounts": [ # Optional. List of Lustre mounts. + { # Represents a mount configuration for Lustre file system. + "filesystem": "A String", # Required. The name of the Lustre filesystem. + "instanceIp": "A String", # Required. IP address of the Lustre instance. + "mountPoint": "A String", # Required. Destination mount path. The Lustre file system will be mounted for the user under /mnt/lustre/ + "volumeHandle": "A String", # Required. The unique identifier of the Lustre volume. + }, + ], "machineSpec": { # Specification of a single machine. # Optional. Immutable. The specification of a single machine. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. @@ -672,6 +696,14 @@

Method Details

"bootDiskSizeGb": 42, # Size in GB of the boot disk (default is 100GB). "bootDiskType": "A String", # Type of the boot disk. For non-A3U machines, the default value is "pd-ssd", for A3U machines, the default value is "hyperdisk-balanced". Valid values: "pd-ssd" (Persistent Disk Solid State Drive), "pd-standard" (Persistent Disk Hard Disk Drive) or "hyperdisk-balanced". }, + "lustreMounts": [ # Optional. List of Lustre mounts. + { # Represents a mount configuration for Lustre file system. + "filesystem": "A String", # Required. The name of the Lustre filesystem. + "instanceIp": "A String", # Required. IP address of the Lustre instance. + "mountPoint": "A String", # Required. Destination mount path. The Lustre file system will be mounted for the user under /mnt/lustre/ + "volumeHandle": "A String", # Required. The unique identifier of the Lustre volume. + }, + ], "machineSpec": { # Specification of a single machine. # Optional. Immutable. The specification of a single machine. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. diff --git a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html index a74c9f3d33e..5e76119e922 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html +++ b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html @@ -208,7 +208,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -294,7 +294,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -426,7 +426,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -1637,7 +1637,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -1779,7 +1779,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -2065,7 +2065,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -3850,7 +3850,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -3992,7 +3992,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -4278,7 +4278,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. diff --git a/docs/dyn/aiplatform_v1.projects.locations.evaluationItems.html b/docs/dyn/aiplatform_v1.projects.locations.evaluationItems.html index 537b43aa2f6..f6303d34007 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.evaluationItems.html +++ b/docs/dyn/aiplatform_v1.projects.locations.evaluationItems.html @@ -156,7 +156,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -271,7 +271,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -321,7 +321,7 @@

Method Details

}, }, }, - "gcsUri": "A String", # The GCS object where the request or response is stored. + "gcsUri": "A String", # The Cloud Storage object where the request or response is stored. "labels": { # Optional. Labels for the EvaluationItem. "a_key": "A String", }, @@ -386,7 +386,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -501,7 +501,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -551,7 +551,7 @@

Method Details

}, }, }, - "gcsUri": "A String", # The GCS object where the request or response is stored. + "gcsUri": "A String", # The Cloud Storage object where the request or response is stored. "labels": { # Optional. Labels for the EvaluationItem. "a_key": "A String", }, @@ -658,7 +658,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -773,7 +773,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -823,7 +823,7 @@

Method Details

}, }, }, - "gcsUri": "A String", # The GCS object where the request or response is stored. + "gcsUri": "A String", # The Cloud Storage object where the request or response is stored. "labels": { # Optional. Labels for the EvaluationItem. "a_key": "A String", }, @@ -901,7 +901,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -1016,7 +1016,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -1066,7 +1066,7 @@

Method Details

}, }, }, - "gcsUri": "A String", # The GCS object where the request or response is stored. + "gcsUri": "A String", # The Cloud Storage object where the request or response is stored. "labels": { # Optional. Labels for the EvaluationItem. "a_key": "A String", }, diff --git a/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html b/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html index 5dc12113c63..e0401192183 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html +++ b/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html @@ -143,7 +143,7 @@

Method Details

"a_key": "A String", }, "promptColumn": "A String", # Optional. The name of the column that contains the requests to evaluate. This will be in evaluation_item.EvalPrompt format. - "rubricsColumn": "A String", # Optional. The name of the column that contains the rubrics. This will be in evaluation_rubric.RubricGroup format (cl/762595858). + "rubricsColumn": "A String", # Optional. The name of the column that contains the rubrics. This is in evaluation_rubric.RubricGroup format. "samplingConfig": { # The sampling config. # Optional. The sampling config for the bigquery resource. "samplingCount": 42, # Optional. The total number of logged data to import. If available data is less than the sampling count, all data will be imported. Default is 100. "samplingDuration": "A String", # Optional. How long to wait before sampling data from the BigQuery table. If not specified, defaults to 0. @@ -891,7 +891,7 @@

Method Details

"a_key": "A String", }, "promptColumn": "A String", # Optional. The name of the column that contains the requests to evaluate. This will be in evaluation_item.EvalPrompt format. - "rubricsColumn": "A String", # Optional. The name of the column that contains the rubrics. This will be in evaluation_rubric.RubricGroup format (cl/762595858). + "rubricsColumn": "A String", # Optional. The name of the column that contains the rubrics. This is in evaluation_rubric.RubricGroup format. "samplingConfig": { # The sampling config. # Optional. The sampling config for the bigquery resource. "samplingCount": 42, # Optional. The total number of logged data to import. If available data is less than the sampling count, all data will be imported. Default is 100. "samplingDuration": "A String", # Optional. How long to wait before sampling data from the BigQuery table. If not specified, defaults to 0. @@ -1681,7 +1681,7 @@

Method Details

"a_key": "A String", }, "promptColumn": "A String", # Optional. The name of the column that contains the requests to evaluate. This will be in evaluation_item.EvalPrompt format. - "rubricsColumn": "A String", # Optional. The name of the column that contains the rubrics. This will be in evaluation_rubric.RubricGroup format (cl/762595858). + "rubricsColumn": "A String", # Optional. The name of the column that contains the rubrics. This is in evaluation_rubric.RubricGroup format. "samplingConfig": { # The sampling config. # Optional. The sampling config for the bigquery resource. "samplingCount": 42, # Optional. The total number of logged data to import. If available data is less than the sampling count, all data will be imported. Default is 100. "samplingDuration": "A String", # Optional. How long to wait before sampling data from the BigQuery table. If not specified, defaults to 0. @@ -2442,7 +2442,7 @@

Method Details

"a_key": "A String", }, "promptColumn": "A String", # Optional. The name of the column that contains the requests to evaluate. This will be in evaluation_item.EvalPrompt format. - "rubricsColumn": "A String", # Optional. The name of the column that contains the rubrics. This will be in evaluation_rubric.RubricGroup format (cl/762595858). + "rubricsColumn": "A String", # Optional. The name of the column that contains the rubrics. This is in evaluation_rubric.RubricGroup format. "samplingConfig": { # The sampling config. # Optional. The sampling config for the bigquery resource. "samplingCount": 42, # Optional. The total number of logged data to import. If available data is less than the sampling count, all data will be imported. Default is 100. "samplingDuration": "A String", # Optional. How long to wait before sampling data from the BigQuery table. If not specified, defaults to 0. diff --git a/docs/dyn/aiplatform_v1.projects.locations.html b/docs/dyn/aiplatform_v1.projects.locations.html index 417a3f081b9..76bf68c1ff2 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.html @@ -333,7 +333,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -423,7 +423,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -504,7 +504,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -817,6 +817,88 @@

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. + "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. + "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: 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. # 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. + "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. }, "dataset": { # The dataset used for evaluation. # Required. The dataset used for evaluation. @@ -846,6 +928,88 @@

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. + "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. + "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: 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. # 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. + "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. @@ -859,6 +1023,88 @@

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. + "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. + "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: 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. # 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. + "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. @@ -948,6 +1194,88 @@

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. + "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. + "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: 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. # 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. + "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. }, "bleuInput": { # Input for bleu metric. # Instances and metric spec for bleu metric. @@ -1043,7 +1371,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -1097,7 +1425,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -1149,7 +1477,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -1201,7 +1529,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -1266,6 +1594,88 @@

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. + "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. + "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: 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. # 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. + "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. @@ -1279,6 +1689,88 @@

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. + "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. + "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: 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. # 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. + "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. @@ -1357,7 +1849,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -1450,7 +1942,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -2053,7 +2545,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -2089,6 +2581,88 @@

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. + "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. + "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: 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. # 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. + "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. @@ -2158,7 +2732,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -2233,7 +2807,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. diff --git a/docs/dyn/aiplatform_v1.projects.locations.hyperparameterTuningJobs.html b/docs/dyn/aiplatform_v1.projects.locations.hyperparameterTuningJobs.html index d01396fe26a..4f8aa433a63 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.hyperparameterTuningJobs.html +++ b/docs/dyn/aiplatform_v1.projects.locations.hyperparameterTuningJobs.html @@ -315,6 +315,14 @@

Method Details

"bootDiskSizeGb": 42, # Size in GB of the boot disk (default is 100GB). "bootDiskType": "A String", # Type of the boot disk. For non-A3U machines, the default value is "pd-ssd", for A3U machines, the default value is "hyperdisk-balanced". Valid values: "pd-ssd" (Persistent Disk Solid State Drive), "pd-standard" (Persistent Disk Hard Disk Drive) or "hyperdisk-balanced". }, + "lustreMounts": [ # Optional. List of Lustre mounts. + { # Represents a mount configuration for Lustre file system. + "filesystem": "A String", # Required. The name of the Lustre filesystem. + "instanceIp": "A String", # Required. IP address of the Lustre instance. + "mountPoint": "A String", # Required. Destination mount path. The Lustre file system will be mounted for the user under /mnt/lustre/ + "volumeHandle": "A String", # Required. The unique identifier of the Lustre volume. + }, + ], "machineSpec": { # Specification of a single machine. # Optional. Immutable. The specification of a single machine. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. @@ -585,6 +593,14 @@

Method Details

"bootDiskSizeGb": 42, # Size in GB of the boot disk (default is 100GB). "bootDiskType": "A String", # Type of the boot disk. For non-A3U machines, the default value is "pd-ssd", for A3U machines, the default value is "hyperdisk-balanced". Valid values: "pd-ssd" (Persistent Disk Solid State Drive), "pd-standard" (Persistent Disk Hard Disk Drive) or "hyperdisk-balanced". }, + "lustreMounts": [ # Optional. List of Lustre mounts. + { # Represents a mount configuration for Lustre file system. + "filesystem": "A String", # Required. The name of the Lustre filesystem. + "instanceIp": "A String", # Required. IP address of the Lustre instance. + "mountPoint": "A String", # Required. Destination mount path. The Lustre file system will be mounted for the user under /mnt/lustre/ + "volumeHandle": "A String", # Required. The unique identifier of the Lustre volume. + }, + ], "machineSpec": { # Specification of a single machine. # Optional. Immutable. The specification of a single machine. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. @@ -897,6 +913,14 @@

Method Details

"bootDiskSizeGb": 42, # Size in GB of the boot disk (default is 100GB). "bootDiskType": "A String", # Type of the boot disk. For non-A3U machines, the default value is "pd-ssd", for A3U machines, the default value is "hyperdisk-balanced". Valid values: "pd-ssd" (Persistent Disk Solid State Drive), "pd-standard" (Persistent Disk Hard Disk Drive) or "hyperdisk-balanced". }, + "lustreMounts": [ # Optional. List of Lustre mounts. + { # Represents a mount configuration for Lustre file system. + "filesystem": "A String", # Required. The name of the Lustre filesystem. + "instanceIp": "A String", # Required. IP address of the Lustre instance. + "mountPoint": "A String", # Required. Destination mount path. The Lustre file system will be mounted for the user under /mnt/lustre/ + "volumeHandle": "A String", # Required. The unique identifier of the Lustre volume. + }, + ], "machineSpec": { # Specification of a single machine. # Optional. Immutable. The specification of a single machine. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. @@ -1180,6 +1204,14 @@

Method Details

"bootDiskSizeGb": 42, # Size in GB of the boot disk (default is 100GB). "bootDiskType": "A String", # Type of the boot disk. For non-A3U machines, the default value is "pd-ssd", for A3U machines, the default value is "hyperdisk-balanced". Valid values: "pd-ssd" (Persistent Disk Solid State Drive), "pd-standard" (Persistent Disk Hard Disk Drive) or "hyperdisk-balanced". }, + "lustreMounts": [ # Optional. List of Lustre mounts. + { # Represents a mount configuration for Lustre file system. + "filesystem": "A String", # Required. The name of the Lustre filesystem. + "instanceIp": "A String", # Required. IP address of the Lustre instance. + "mountPoint": "A String", # Required. Destination mount path. The Lustre file system will be mounted for the user under /mnt/lustre/ + "volumeHandle": "A String", # Required. The unique identifier of the Lustre volume. + }, + ], "machineSpec": { # Specification of a single machine. # Optional. Immutable. The specification of a single machine. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. diff --git a/docs/dyn/aiplatform_v1.projects.locations.nasJobs.html b/docs/dyn/aiplatform_v1.projects.locations.nasJobs.html index 441e53b2241..cdb83d77b82 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.nasJobs.html +++ b/docs/dyn/aiplatform_v1.projects.locations.nasJobs.html @@ -268,6 +268,14 @@

Method Details

"bootDiskSizeGb": 42, # Size in GB of the boot disk (default is 100GB). "bootDiskType": "A String", # Type of the boot disk. For non-A3U machines, the default value is "pd-ssd", for A3U machines, the default value is "hyperdisk-balanced". Valid values: "pd-ssd" (Persistent Disk Solid State Drive), "pd-standard" (Persistent Disk Hard Disk Drive) or "hyperdisk-balanced". }, + "lustreMounts": [ # Optional. List of Lustre mounts. + { # Represents a mount configuration for Lustre file system. + "filesystem": "A String", # Required. The name of the Lustre filesystem. + "instanceIp": "A String", # Required. IP address of the Lustre instance. + "mountPoint": "A String", # Required. Destination mount path. The Lustre file system will be mounted for the user under /mnt/lustre/ + "volumeHandle": "A String", # Required. The unique identifier of the Lustre volume. + }, + ], "machineSpec": { # Specification of a single machine. # Optional. Immutable. The specification of a single machine. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. @@ -369,6 +377,14 @@

Method Details

"bootDiskSizeGb": 42, # Size in GB of the boot disk (default is 100GB). "bootDiskType": "A String", # Type of the boot disk. For non-A3U machines, the default value is "pd-ssd", for A3U machines, the default value is "hyperdisk-balanced". Valid values: "pd-ssd" (Persistent Disk Solid State Drive), "pd-standard" (Persistent Disk Hard Disk Drive) or "hyperdisk-balanced". }, + "lustreMounts": [ # Optional. List of Lustre mounts. + { # Represents a mount configuration for Lustre file system. + "filesystem": "A String", # Required. The name of the Lustre filesystem. + "instanceIp": "A String", # Required. IP address of the Lustre instance. + "mountPoint": "A String", # Required. Destination mount path. The Lustre file system will be mounted for the user under /mnt/lustre/ + "volumeHandle": "A String", # Required. The unique identifier of the Lustre volume. + }, + ], "machineSpec": { # Specification of a single machine. # Optional. Immutable. The specification of a single machine. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. @@ -558,6 +574,14 @@

Method Details

"bootDiskSizeGb": 42, # Size in GB of the boot disk (default is 100GB). "bootDiskType": "A String", # Type of the boot disk. For non-A3U machines, the default value is "pd-ssd", for A3U machines, the default value is "hyperdisk-balanced". Valid values: "pd-ssd" (Persistent Disk Solid State Drive), "pd-standard" (Persistent Disk Hard Disk Drive) or "hyperdisk-balanced". }, + "lustreMounts": [ # Optional. List of Lustre mounts. + { # Represents a mount configuration for Lustre file system. + "filesystem": "A String", # Required. The name of the Lustre filesystem. + "instanceIp": "A String", # Required. IP address of the Lustre instance. + "mountPoint": "A String", # Required. Destination mount path. The Lustre file system will be mounted for the user under /mnt/lustre/ + "volumeHandle": "A String", # Required. The unique identifier of the Lustre volume. + }, + ], "machineSpec": { # Specification of a single machine. # Optional. Immutable. The specification of a single machine. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. @@ -659,6 +683,14 @@

Method Details

"bootDiskSizeGb": 42, # Size in GB of the boot disk (default is 100GB). "bootDiskType": "A String", # Type of the boot disk. For non-A3U machines, the default value is "pd-ssd", for A3U machines, the default value is "hyperdisk-balanced". Valid values: "pd-ssd" (Persistent Disk Solid State Drive), "pd-standard" (Persistent Disk Hard Disk Drive) or "hyperdisk-balanced". }, + "lustreMounts": [ # Optional. List of Lustre mounts. + { # Represents a mount configuration for Lustre file system. + "filesystem": "A String", # Required. The name of the Lustre filesystem. + "instanceIp": "A String", # Required. IP address of the Lustre instance. + "mountPoint": "A String", # Required. Destination mount path. The Lustre file system will be mounted for the user under /mnt/lustre/ + "volumeHandle": "A String", # Required. The unique identifier of the Lustre volume. + }, + ], "machineSpec": { # Specification of a single machine. # Optional. Immutable. The specification of a single machine. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. @@ -890,6 +922,14 @@

Method Details

"bootDiskSizeGb": 42, # Size in GB of the boot disk (default is 100GB). "bootDiskType": "A String", # Type of the boot disk. For non-A3U machines, the default value is "pd-ssd", for A3U machines, the default value is "hyperdisk-balanced". Valid values: "pd-ssd" (Persistent Disk Solid State Drive), "pd-standard" (Persistent Disk Hard Disk Drive) or "hyperdisk-balanced". }, + "lustreMounts": [ # Optional. List of Lustre mounts. + { # Represents a mount configuration for Lustre file system. + "filesystem": "A String", # Required. The name of the Lustre filesystem. + "instanceIp": "A String", # Required. IP address of the Lustre instance. + "mountPoint": "A String", # Required. Destination mount path. The Lustre file system will be mounted for the user under /mnt/lustre/ + "volumeHandle": "A String", # Required. The unique identifier of the Lustre volume. + }, + ], "machineSpec": { # Specification of a single machine. # Optional. Immutable. The specification of a single machine. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. @@ -991,6 +1031,14 @@

Method Details

"bootDiskSizeGb": 42, # Size in GB of the boot disk (default is 100GB). "bootDiskType": "A String", # Type of the boot disk. For non-A3U machines, the default value is "pd-ssd", for A3U machines, the default value is "hyperdisk-balanced". Valid values: "pd-ssd" (Persistent Disk Solid State Drive), "pd-standard" (Persistent Disk Hard Disk Drive) or "hyperdisk-balanced". }, + "lustreMounts": [ # Optional. List of Lustre mounts. + { # Represents a mount configuration for Lustre file system. + "filesystem": "A String", # Required. The name of the Lustre filesystem. + "instanceIp": "A String", # Required. IP address of the Lustre instance. + "mountPoint": "A String", # Required. Destination mount path. The Lustre file system will be mounted for the user under /mnt/lustre/ + "volumeHandle": "A String", # Required. The unique identifier of the Lustre volume. + }, + ], "machineSpec": { # Specification of a single machine. # Optional. Immutable. The specification of a single machine. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. @@ -1193,6 +1241,14 @@

Method Details

"bootDiskSizeGb": 42, # Size in GB of the boot disk (default is 100GB). "bootDiskType": "A String", # Type of the boot disk. For non-A3U machines, the default value is "pd-ssd", for A3U machines, the default value is "hyperdisk-balanced". Valid values: "pd-ssd" (Persistent Disk Solid State Drive), "pd-standard" (Persistent Disk Hard Disk Drive) or "hyperdisk-balanced". }, + "lustreMounts": [ # Optional. List of Lustre mounts. + { # Represents a mount configuration for Lustre file system. + "filesystem": "A String", # Required. The name of the Lustre filesystem. + "instanceIp": "A String", # Required. IP address of the Lustre instance. + "mountPoint": "A String", # Required. Destination mount path. The Lustre file system will be mounted for the user under /mnt/lustre/ + "volumeHandle": "A String", # Required. The unique identifier of the Lustre volume. + }, + ], "machineSpec": { # Specification of a single machine. # Optional. Immutable. The specification of a single machine. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. @@ -1294,6 +1350,14 @@

Method Details

"bootDiskSizeGb": 42, # Size in GB of the boot disk (default is 100GB). "bootDiskType": "A String", # Type of the boot disk. For non-A3U machines, the default value is "pd-ssd", for A3U machines, the default value is "hyperdisk-balanced". Valid values: "pd-ssd" (Persistent Disk Solid State Drive), "pd-standard" (Persistent Disk Hard Disk Drive) or "hyperdisk-balanced". }, + "lustreMounts": [ # Optional. List of Lustre mounts. + { # Represents a mount configuration for Lustre file system. + "filesystem": "A String", # Required. The name of the Lustre filesystem. + "instanceIp": "A String", # Required. IP address of the Lustre instance. + "mountPoint": "A String", # Required. Destination mount path. The Lustre file system will be mounted for the user under /mnt/lustre/ + "volumeHandle": "A String", # Required. The unique identifier of the Lustre volume. + }, + ], "machineSpec": { # Specification of a single machine. # Optional. Immutable. The specification of a single machine. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. diff --git a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html index cc1f5193187..8d8227c6db3 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html @@ -144,7 +144,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -230,7 +230,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -362,7 +362,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -679,7 +679,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -821,7 +821,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -1107,7 +1107,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -1643,7 +1643,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -1785,7 +1785,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -2071,7 +2071,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. diff --git a/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html b/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html index a3b554005e3..1d229981d33 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html +++ b/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html @@ -222,7 +222,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -395,7 +395,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -575,7 +575,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -761,7 +761,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -962,7 +962,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. diff --git a/docs/dyn/aiplatform_v1.publishers.models.html b/docs/dyn/aiplatform_v1.publishers.models.html index b9cf3732bea..db23a169373 100644 --- a/docs/dyn/aiplatform_v1.publishers.models.html +++ b/docs/dyn/aiplatform_v1.publishers.models.html @@ -138,7 +138,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -224,7 +224,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -356,7 +356,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -673,7 +673,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -815,7 +815,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -1101,7 +1101,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -1982,7 +1982,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -2124,7 +2124,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. @@ -2410,7 +2410,7 @@

Method Details

"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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. diff --git a/docs/dyn/aiplatform_v1beta1.endpoints.html b/docs/dyn/aiplatform_v1beta1.endpoints.html index fbe32bf7e44..267867eccaf 100644 --- a/docs/dyn/aiplatform_v1beta1.endpoints.html +++ b/docs/dyn/aiplatform_v1beta1.endpoints.html @@ -141,7 +141,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -229,7 +229,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -366,7 +366,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -692,7 +692,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -839,7 +839,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -1134,7 +1134,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -1447,7 +1447,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -1594,7 +1594,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -1889,7 +1889,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html b/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html index 162ba524d31..6dd79b5ef14 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html @@ -133,7 +133,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -189,7 +189,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -475,7 +475,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -531,7 +531,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -842,7 +842,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -898,7 +898,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -1195,7 +1195,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -1251,7 +1251,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -1556,7 +1556,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -1612,7 +1612,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -1899,7 +1899,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -1955,7 +1955,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.customJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.customJobs.html index 19bfa6f0935..e173bf4db79 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.customJobs.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.customJobs.html @@ -212,6 +212,14 @@

Method Details

"bootDiskSizeGb": 42, # Size in GB of the boot disk (default is 100GB). "bootDiskType": "A String", # Type of the boot disk. For non-A3U machines, the default value is "pd-ssd", for A3U machines, the default value is "hyperdisk-balanced". Valid values: "pd-ssd" (Persistent Disk Solid State Drive), "pd-standard" (Persistent Disk Hard Disk Drive) or "hyperdisk-balanced". }, + "lustreMounts": [ # Optional. List of Lustre mounts. + { # Represents a mount configuration for Lustre file system. + "filesystem": "A String", # Required. The name of the Lustre filesystem. + "instanceIp": "A String", # Required. IP address of the Lustre instance. + "mountPoint": "A String", # Required. Destination mount path. The Lustre file system will be mounted for the user under /mnt/lustre/ + "volumeHandle": "A String", # Required. The unique identifier of the Lustre volume. + }, + ], "machineSpec": { # Specification of a single machine. # Optional. Immutable. The specification of a single machine. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. @@ -349,6 +357,14 @@

Method Details

"bootDiskSizeGb": 42, # Size in GB of the boot disk (default is 100GB). "bootDiskType": "A String", # Type of the boot disk. For non-A3U machines, the default value is "pd-ssd", for A3U machines, the default value is "hyperdisk-balanced". Valid values: "pd-ssd" (Persistent Disk Solid State Drive), "pd-standard" (Persistent Disk Hard Disk Drive) or "hyperdisk-balanced". }, + "lustreMounts": [ # Optional. List of Lustre mounts. + { # Represents a mount configuration for Lustre file system. + "filesystem": "A String", # Required. The name of the Lustre filesystem. + "instanceIp": "A String", # Required. IP address of the Lustre instance. + "mountPoint": "A String", # Required. Destination mount path. The Lustre file system will be mounted for the user under /mnt/lustre/ + "volumeHandle": "A String", # Required. The unique identifier of the Lustre volume. + }, + ], "machineSpec": { # Specification of a single machine. # Optional. Immutable. The specification of a single machine. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. @@ -528,6 +544,14 @@

Method Details

"bootDiskSizeGb": 42, # Size in GB of the boot disk (default is 100GB). "bootDiskType": "A String", # Type of the boot disk. For non-A3U machines, the default value is "pd-ssd", for A3U machines, the default value is "hyperdisk-balanced". Valid values: "pd-ssd" (Persistent Disk Solid State Drive), "pd-standard" (Persistent Disk Hard Disk Drive) or "hyperdisk-balanced". }, + "lustreMounts": [ # Optional. List of Lustre mounts. + { # Represents a mount configuration for Lustre file system. + "filesystem": "A String", # Required. The name of the Lustre filesystem. + "instanceIp": "A String", # Required. IP address of the Lustre instance. + "mountPoint": "A String", # Required. Destination mount path. The Lustre file system will be mounted for the user under /mnt/lustre/ + "volumeHandle": "A String", # Required. The unique identifier of the Lustre volume. + }, + ], "machineSpec": { # Specification of a single machine. # Optional. Immutable. The specification of a single machine. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. @@ -678,6 +702,14 @@

Method Details

"bootDiskSizeGb": 42, # Size in GB of the boot disk (default is 100GB). "bootDiskType": "A String", # Type of the boot disk. For non-A3U machines, the default value is "pd-ssd", for A3U machines, the default value is "hyperdisk-balanced". Valid values: "pd-ssd" (Persistent Disk Solid State Drive), "pd-standard" (Persistent Disk Hard Disk Drive) or "hyperdisk-balanced". }, + "lustreMounts": [ # Optional. List of Lustre mounts. + { # Represents a mount configuration for Lustre file system. + "filesystem": "A String", # Required. The name of the Lustre filesystem. + "instanceIp": "A String", # Required. IP address of the Lustre instance. + "mountPoint": "A String", # Required. Destination mount path. The Lustre file system will be mounted for the user under /mnt/lustre/ + "volumeHandle": "A String", # Required. The unique identifier of the Lustre volume. + }, + ], "machineSpec": { # Specification of a single machine. # Optional. Immutable. The specification of a single machine. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html index 91d39d25867..bdd99c921f2 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html @@ -179,7 +179,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -323,7 +323,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -647,7 +647,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -791,7 +791,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html index 141cd06bde1..83005a18103 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html @@ -218,7 +218,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -306,7 +306,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -443,7 +443,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -1838,7 +1838,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -1985,7 +1985,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -2280,7 +2280,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -4284,7 +4284,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -4431,7 +4431,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -4726,7 +4726,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.html b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.html index 6512419532c..53d93b1a4ba 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.html @@ -162,7 +162,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -279,7 +279,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -330,7 +330,7 @@

Method Details

}, }, }, - "gcsUri": "A String", # The GCS object where the request or response is stored. + "gcsUri": "A String", # The Cloud Storage object where the request or response is stored. "labels": { # Optional. Labels for the EvaluationItem. "a_key": "A String", }, @@ -396,7 +396,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -513,7 +513,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -564,7 +564,7 @@

Method Details

}, }, }, - "gcsUri": "A String", # The GCS object where the request or response is stored. + "gcsUri": "A String", # The Cloud Storage object where the request or response is stored. "labels": { # Optional. Labels for the EvaluationItem. "a_key": "A String", }, @@ -672,7 +672,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -789,7 +789,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -840,7 +840,7 @@

Method Details

}, }, }, - "gcsUri": "A String", # The GCS object where the request or response is stored. + "gcsUri": "A String", # The Cloud Storage object where the request or response is stored. "labels": { # Optional. Labels for the EvaluationItem. "a_key": "A String", }, @@ -919,7 +919,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -1036,7 +1036,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -1087,7 +1087,7 @@

Method Details

}, }, }, - "gcsUri": "A String", # The GCS object where the request or response is stored. + "gcsUri": "A String", # The Cloud Storage object where the request or response is stored. "labels": { # Optional. Labels for the EvaluationItem. "a_key": "A String", }, diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html index 6d74a5fa9e2..efb397b4b58 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html @@ -148,7 +148,7 @@

Method Details

"a_key": "A String", }, "promptColumn": "A String", # Optional. The name of the column that contains the requests to evaluate. This will be in evaluation_item.EvalPrompt format. - "rubricsColumn": "A String", # Optional. The name of the column that contains the rubrics. This will be in evaluation_rubric.RubricGroup format (cl/762595858). + "rubricsColumn": "A String", # Optional. The name of the column that contains the rubrics. This is in evaluation_rubric.RubricGroup format. "samplingConfig": { # The sampling config. # Optional. The sampling config for the bigquery resource. "samplingCount": 42, # Optional. The total number of logged data to import. If available data is less than the sampling count, all data will be imported. Default is 100. "samplingDuration": "A String", # Optional. How long to wait before sampling data from the BigQuery table. If not specified, defaults to 0. @@ -917,7 +917,7 @@

Method Details

"a_key": "A String", }, "promptColumn": "A String", # Optional. The name of the column that contains the requests to evaluate. This will be in evaluation_item.EvalPrompt format. - "rubricsColumn": "A String", # Optional. The name of the column that contains the rubrics. This will be in evaluation_rubric.RubricGroup format (cl/762595858). + "rubricsColumn": "A String", # Optional. The name of the column that contains the rubrics. This is in evaluation_rubric.RubricGroup format. "samplingConfig": { # The sampling config. # Optional. The sampling config for the bigquery resource. "samplingCount": 42, # Optional. The total number of logged data to import. If available data is less than the sampling count, all data will be imported. Default is 100. "samplingDuration": "A String", # Optional. How long to wait before sampling data from the BigQuery table. If not specified, defaults to 0. @@ -1728,7 +1728,7 @@

Method Details

"a_key": "A String", }, "promptColumn": "A String", # Optional. The name of the column that contains the requests to evaluate. This will be in evaluation_item.EvalPrompt format. - "rubricsColumn": "A String", # Optional. The name of the column that contains the rubrics. This will be in evaluation_rubric.RubricGroup format (cl/762595858). + "rubricsColumn": "A String", # Optional. The name of the column that contains the rubrics. This is in evaluation_rubric.RubricGroup format. "samplingConfig": { # The sampling config. # Optional. The sampling config for the bigquery resource. "samplingCount": 42, # Optional. The total number of logged data to import. If available data is less than the sampling count, all data will be imported. Default is 100. "samplingDuration": "A String", # Optional. How long to wait before sampling data from the BigQuery table. If not specified, defaults to 0. @@ -2510,7 +2510,7 @@

Method Details

"a_key": "A String", }, "promptColumn": "A String", # Optional. The name of the column that contains the requests to evaluate. This will be in evaluation_item.EvalPrompt format. - "rubricsColumn": "A String", # Optional. The name of the column that contains the rubrics. This will be in evaluation_rubric.RubricGroup format (cl/762595858). + "rubricsColumn": "A String", # Optional. The name of the column that contains the rubrics. This is in evaluation_rubric.RubricGroup format. "samplingConfig": { # The sampling config. # Optional. The sampling config for the bigquery resource. "samplingCount": 42, # Optional. The total number of logged data to import. If available data is less than the sampling count, all data will be imported. Default is 100. "samplingDuration": "A String", # Optional. How long to wait before sampling data from the BigQuery table. If not specified, defaults to 0. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.exampleStores.html b/docs/dyn/aiplatform_v1beta1.projects.locations.exampleStores.html index 07aeb1dd810..35673828263 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.exampleStores.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.exampleStores.html @@ -263,7 +263,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -313,7 +313,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -567,7 +567,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -649,7 +649,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -699,7 +699,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -780,7 +780,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -830,7 +830,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -909,7 +909,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -959,7 +959,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html index 5796e9c2b29..0f67f9567ad 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html @@ -1166,7 +1166,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -1227,7 +1227,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.html index f4d09264925..e72e45f488b 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.html @@ -385,7 +385,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -484,7 +484,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -567,7 +567,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -973,6 +973,91 @@

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. + "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. + "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. }, "dataset": { # The dataset used for evaluation. # Required. The dataset used for evaluation. @@ -1002,6 +1087,91 @@

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. + "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. + "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. @@ -1015,6 +1185,91 @@

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. + "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. + "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. @@ -1104,6 +1359,91 @@

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. + "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. + "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. }, "bleuInput": { # Input for bleu metric. # Instances and metric spec for bleu metric. @@ -1200,7 +1540,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -1256,7 +1596,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -1310,7 +1650,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -1364,7 +1704,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -1430,6 +1770,91 @@

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. + "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. + "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. @@ -1443,6 +1868,91 @@

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. + "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. + "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. @@ -1522,7 +2032,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -1617,7 +2127,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -2222,7 +2732,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -2259,6 +2769,91 @@

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. + "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. + "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. @@ -2329,7 +2924,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -2406,7 +3001,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.hyperparameterTuningJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.hyperparameterTuningJobs.html index 627399de943..7173eede8d9 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.hyperparameterTuningJobs.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.hyperparameterTuningJobs.html @@ -328,6 +328,14 @@

Method Details

"bootDiskSizeGb": 42, # Size in GB of the boot disk (default is 100GB). "bootDiskType": "A String", # Type of the boot disk. For non-A3U machines, the default value is "pd-ssd", for A3U machines, the default value is "hyperdisk-balanced". Valid values: "pd-ssd" (Persistent Disk Solid State Drive), "pd-standard" (Persistent Disk Hard Disk Drive) or "hyperdisk-balanced". }, + "lustreMounts": [ # Optional. List of Lustre mounts. + { # Represents a mount configuration for Lustre file system. + "filesystem": "A String", # Required. The name of the Lustre filesystem. + "instanceIp": "A String", # Required. IP address of the Lustre instance. + "mountPoint": "A String", # Required. Destination mount path. The Lustre file system will be mounted for the user under /mnt/lustre/ + "volumeHandle": "A String", # Required. The unique identifier of the Lustre volume. + }, + ], "machineSpec": { # Specification of a single machine. # Optional. Immutable. The specification of a single machine. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. @@ -613,6 +621,14 @@

Method Details

"bootDiskSizeGb": 42, # Size in GB of the boot disk (default is 100GB). "bootDiskType": "A String", # Type of the boot disk. For non-A3U machines, the default value is "pd-ssd", for A3U machines, the default value is "hyperdisk-balanced". Valid values: "pd-ssd" (Persistent Disk Solid State Drive), "pd-standard" (Persistent Disk Hard Disk Drive) or "hyperdisk-balanced". }, + "lustreMounts": [ # Optional. List of Lustre mounts. + { # Represents a mount configuration for Lustre file system. + "filesystem": "A String", # Required. The name of the Lustre filesystem. + "instanceIp": "A String", # Required. IP address of the Lustre instance. + "mountPoint": "A String", # Required. Destination mount path. The Lustre file system will be mounted for the user under /mnt/lustre/ + "volumeHandle": "A String", # Required. The unique identifier of the Lustre volume. + }, + ], "machineSpec": { # Specification of a single machine. # Optional. Immutable. The specification of a single machine. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. @@ -940,6 +956,14 @@

Method Details

"bootDiskSizeGb": 42, # Size in GB of the boot disk (default is 100GB). "bootDiskType": "A String", # Type of the boot disk. For non-A3U machines, the default value is "pd-ssd", for A3U machines, the default value is "hyperdisk-balanced". Valid values: "pd-ssd" (Persistent Disk Solid State Drive), "pd-standard" (Persistent Disk Hard Disk Drive) or "hyperdisk-balanced". }, + "lustreMounts": [ # Optional. List of Lustre mounts. + { # Represents a mount configuration for Lustre file system. + "filesystem": "A String", # Required. The name of the Lustre filesystem. + "instanceIp": "A String", # Required. IP address of the Lustre instance. + "mountPoint": "A String", # Required. Destination mount path. The Lustre file system will be mounted for the user under /mnt/lustre/ + "volumeHandle": "A String", # Required. The unique identifier of the Lustre volume. + }, + ], "machineSpec": { # Specification of a single machine. # Optional. Immutable. The specification of a single machine. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. @@ -1238,6 +1262,14 @@

Method Details

"bootDiskSizeGb": 42, # Size in GB of the boot disk (default is 100GB). "bootDiskType": "A String", # Type of the boot disk. For non-A3U machines, the default value is "pd-ssd", for A3U machines, the default value is "hyperdisk-balanced". Valid values: "pd-ssd" (Persistent Disk Solid State Drive), "pd-standard" (Persistent Disk Hard Disk Drive) or "hyperdisk-balanced". }, + "lustreMounts": [ # Optional. List of Lustre mounts. + { # Represents a mount configuration for Lustre file system. + "filesystem": "A String", # Required. The name of the Lustre filesystem. + "instanceIp": "A String", # Required. IP address of the Lustre instance. + "mountPoint": "A String", # Required. Destination mount path. The Lustre file system will be mounted for the user under /mnt/lustre/ + "volumeHandle": "A String", # Required. The unique identifier of the Lustre volume. + }, + ], "machineSpec": { # Specification of a single machine. # Optional. Immutable. The specification of a single machine. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.nasJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.nasJobs.html index ccebd1e1924..5bdb8fb8520 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.nasJobs.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.nasJobs.html @@ -268,6 +268,14 @@

Method Details

"bootDiskSizeGb": 42, # Size in GB of the boot disk (default is 100GB). "bootDiskType": "A String", # Type of the boot disk. For non-A3U machines, the default value is "pd-ssd", for A3U machines, the default value is "hyperdisk-balanced". Valid values: "pd-ssd" (Persistent Disk Solid State Drive), "pd-standard" (Persistent Disk Hard Disk Drive) or "hyperdisk-balanced". }, + "lustreMounts": [ # Optional. List of Lustre mounts. + { # Represents a mount configuration for Lustre file system. + "filesystem": "A String", # Required. The name of the Lustre filesystem. + "instanceIp": "A String", # Required. IP address of the Lustre instance. + "mountPoint": "A String", # Required. Destination mount path. The Lustre file system will be mounted for the user under /mnt/lustre/ + "volumeHandle": "A String", # Required. The unique identifier of the Lustre volume. + }, + ], "machineSpec": { # Specification of a single machine. # Optional. Immutable. The specification of a single machine. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. @@ -371,6 +379,14 @@

Method Details

"bootDiskSizeGb": 42, # Size in GB of the boot disk (default is 100GB). "bootDiskType": "A String", # Type of the boot disk. For non-A3U machines, the default value is "pd-ssd", for A3U machines, the default value is "hyperdisk-balanced". Valid values: "pd-ssd" (Persistent Disk Solid State Drive), "pd-standard" (Persistent Disk Hard Disk Drive) or "hyperdisk-balanced". }, + "lustreMounts": [ # Optional. List of Lustre mounts. + { # Represents a mount configuration for Lustre file system. + "filesystem": "A String", # Required. The name of the Lustre filesystem. + "instanceIp": "A String", # Required. IP address of the Lustre instance. + "mountPoint": "A String", # Required. Destination mount path. The Lustre file system will be mounted for the user under /mnt/lustre/ + "volumeHandle": "A String", # Required. The unique identifier of the Lustre volume. + }, + ], "machineSpec": { # Specification of a single machine. # Optional. Immutable. The specification of a single machine. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. @@ -562,6 +578,14 @@

Method Details

"bootDiskSizeGb": 42, # Size in GB of the boot disk (default is 100GB). "bootDiskType": "A String", # Type of the boot disk. For non-A3U machines, the default value is "pd-ssd", for A3U machines, the default value is "hyperdisk-balanced". Valid values: "pd-ssd" (Persistent Disk Solid State Drive), "pd-standard" (Persistent Disk Hard Disk Drive) or "hyperdisk-balanced". }, + "lustreMounts": [ # Optional. List of Lustre mounts. + { # Represents a mount configuration for Lustre file system. + "filesystem": "A String", # Required. The name of the Lustre filesystem. + "instanceIp": "A String", # Required. IP address of the Lustre instance. + "mountPoint": "A String", # Required. Destination mount path. The Lustre file system will be mounted for the user under /mnt/lustre/ + "volumeHandle": "A String", # Required. The unique identifier of the Lustre volume. + }, + ], "machineSpec": { # Specification of a single machine. # Optional. Immutable. The specification of a single machine. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. @@ -665,6 +689,14 @@

Method Details

"bootDiskSizeGb": 42, # Size in GB of the boot disk (default is 100GB). "bootDiskType": "A String", # Type of the boot disk. For non-A3U machines, the default value is "pd-ssd", for A3U machines, the default value is "hyperdisk-balanced". Valid values: "pd-ssd" (Persistent Disk Solid State Drive), "pd-standard" (Persistent Disk Hard Disk Drive) or "hyperdisk-balanced". }, + "lustreMounts": [ # Optional. List of Lustre mounts. + { # Represents a mount configuration for Lustre file system. + "filesystem": "A String", # Required. The name of the Lustre filesystem. + "instanceIp": "A String", # Required. IP address of the Lustre instance. + "mountPoint": "A String", # Required. Destination mount path. The Lustre file system will be mounted for the user under /mnt/lustre/ + "volumeHandle": "A String", # Required. The unique identifier of the Lustre volume. + }, + ], "machineSpec": { # Specification of a single machine. # Optional. Immutable. The specification of a single machine. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. @@ -898,6 +930,14 @@

Method Details

"bootDiskSizeGb": 42, # Size in GB of the boot disk (default is 100GB). "bootDiskType": "A String", # Type of the boot disk. For non-A3U machines, the default value is "pd-ssd", for A3U machines, the default value is "hyperdisk-balanced". Valid values: "pd-ssd" (Persistent Disk Solid State Drive), "pd-standard" (Persistent Disk Hard Disk Drive) or "hyperdisk-balanced". }, + "lustreMounts": [ # Optional. List of Lustre mounts. + { # Represents a mount configuration for Lustre file system. + "filesystem": "A String", # Required. The name of the Lustre filesystem. + "instanceIp": "A String", # Required. IP address of the Lustre instance. + "mountPoint": "A String", # Required. Destination mount path. The Lustre file system will be mounted for the user under /mnt/lustre/ + "volumeHandle": "A String", # Required. The unique identifier of the Lustre volume. + }, + ], "machineSpec": { # Specification of a single machine. # Optional. Immutable. The specification of a single machine. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. @@ -1001,6 +1041,14 @@

Method Details

"bootDiskSizeGb": 42, # Size in GB of the boot disk (default is 100GB). "bootDiskType": "A String", # Type of the boot disk. For non-A3U machines, the default value is "pd-ssd", for A3U machines, the default value is "hyperdisk-balanced". Valid values: "pd-ssd" (Persistent Disk Solid State Drive), "pd-standard" (Persistent Disk Hard Disk Drive) or "hyperdisk-balanced". }, + "lustreMounts": [ # Optional. List of Lustre mounts. + { # Represents a mount configuration for Lustre file system. + "filesystem": "A String", # Required. The name of the Lustre filesystem. + "instanceIp": "A String", # Required. IP address of the Lustre instance. + "mountPoint": "A String", # Required. Destination mount path. The Lustre file system will be mounted for the user under /mnt/lustre/ + "volumeHandle": "A String", # Required. The unique identifier of the Lustre volume. + }, + ], "machineSpec": { # Specification of a single machine. # Optional. Immutable. The specification of a single machine. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. @@ -1205,6 +1253,14 @@

Method Details

"bootDiskSizeGb": 42, # Size in GB of the boot disk (default is 100GB). "bootDiskType": "A String", # Type of the boot disk. For non-A3U machines, the default value is "pd-ssd", for A3U machines, the default value is "hyperdisk-balanced". Valid values: "pd-ssd" (Persistent Disk Solid State Drive), "pd-standard" (Persistent Disk Hard Disk Drive) or "hyperdisk-balanced". }, + "lustreMounts": [ # Optional. List of Lustre mounts. + { # Represents a mount configuration for Lustre file system. + "filesystem": "A String", # Required. The name of the Lustre filesystem. + "instanceIp": "A String", # Required. IP address of the Lustre instance. + "mountPoint": "A String", # Required. Destination mount path. The Lustre file system will be mounted for the user under /mnt/lustre/ + "volumeHandle": "A String", # Required. The unique identifier of the Lustre volume. + }, + ], "machineSpec": { # Specification of a single machine. # Optional. Immutable. The specification of a single machine. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. @@ -1308,6 +1364,14 @@

Method Details

"bootDiskSizeGb": 42, # Size in GB of the boot disk (default is 100GB). "bootDiskType": "A String", # Type of the boot disk. For non-A3U machines, the default value is "pd-ssd", for A3U machines, the default value is "hyperdisk-balanced". Valid values: "pd-ssd" (Persistent Disk Solid State Drive), "pd-standard" (Persistent Disk Hard Disk Drive) or "hyperdisk-balanced". }, + "lustreMounts": [ # Optional. List of Lustre mounts. + { # Represents a mount configuration for Lustre file system. + "filesystem": "A String", # Required. The name of the Lustre filesystem. + "instanceIp": "A String", # Required. IP address of the Lustre instance. + "mountPoint": "A String", # Required. Destination mount path. The Lustre file system will be mounted for the user under /mnt/lustre/ + "volumeHandle": "A String", # Required. The unique identifier of the Lustre volume. + }, + ], "machineSpec": { # Specification of a single machine. # Optional. Immutable. The specification of a single machine. "acceleratorCount": 42, # The number of accelerators to attach to the machine. "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html index aa2bf6cceb7..7956405d9bf 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html @@ -157,7 +157,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -245,7 +245,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -382,7 +382,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -780,7 +780,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -927,7 +927,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -1222,7 +1222,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -1850,7 +1850,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -1997,7 +1997,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -2292,7 +2292,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html index 2c9fea0b692..82524870193 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html @@ -177,7 +177,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -424,7 +424,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -613,7 +613,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -807,7 +807,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.html index 0088c38407d..5d59d155988 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.html @@ -233,7 +233,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironments.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironments.html index 35dfa1d353d..dbe8a10df22 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironments.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironments.html @@ -118,6 +118,7 @@

Method Details

{ # SandboxEnvironment is a containerized environment that provides a customizable secure execution runtime for AI agents. "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. @@ -126,6 +127,7 @@

Method Details

}, }, "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. } @@ -256,6 +258,7 @@

Method Details

{ # SandboxEnvironment is a containerized environment that provides a customizable secure execution runtime for AI agents. "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. @@ -264,6 +267,7 @@

Method Details

}, }, "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. } @@ -291,6 +295,7 @@

Method Details

{ # SandboxEnvironment is a containerized environment that provides a customizable secure execution runtime for AI agents. "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. @@ -299,6 +304,7 @@

Method Details

}, }, "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. }, ], 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 f27925ffdb3..3420b379d07 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.events.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.events.html @@ -147,7 +147,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html index 4c5b68174ef..2436e2d6b76 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html @@ -156,7 +156,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html index 760753ac9ff..b7886cd9a3e 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html @@ -265,6 +265,91 @@

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. + "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. + "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. @@ -284,6 +369,91 @@

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. + "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. + "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. @@ -297,6 +467,91 @@

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. + "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. + "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. @@ -363,6 +618,91 @@

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. + "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. + "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. @@ -382,6 +722,91 @@

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. + "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. + "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. @@ -395,6 +820,91 @@

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. + "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. + "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. @@ -501,7 +1011,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -645,7 +1155,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -696,7 +1206,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -793,7 +1303,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -1017,6 +1527,91 @@

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. + "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. + "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. @@ -1036,6 +1631,91 @@

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. + "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. + "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. @@ -1049,6 +1729,91 @@

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. + "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. + "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. @@ -1115,6 +1880,91 @@

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. + "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. + "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. @@ -1134,6 +1984,91 @@

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. + "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. + "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. @@ -1147,6 +2082,91 @@

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. + "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. + "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. @@ -1253,7 +2273,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -1397,7 +2417,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -1448,7 +2468,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -1545,7 +2565,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -1776,6 +2796,91 @@

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. + "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. + "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. @@ -1795,6 +2900,91 @@

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. + "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. + "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. @@ -1808,6 +2998,91 @@

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. + "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. + "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. @@ -1874,6 +3149,91 @@

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. + "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. + "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. @@ -1893,6 +3253,91 @@

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. + "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. + "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. @@ -1906,6 +3351,91 @@

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. + "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. + "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. @@ -2012,7 +3542,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -2156,7 +3686,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -2207,7 +3737,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -2304,7 +3834,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -2541,6 +4071,91 @@

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. + "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. + "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. @@ -2560,6 +4175,91 @@

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. + "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. + "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. @@ -2573,6 +4273,91 @@

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. + "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. + "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. @@ -2639,6 +4424,91 @@

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. + "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. + "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. @@ -2658,6 +4528,91 @@

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. + "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. + "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. @@ -2671,6 +4626,91 @@

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. + "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. + "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. @@ -2777,7 +4817,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -2921,7 +4961,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -2972,7 +5012,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -3069,7 +5109,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -3210,7 +5250,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -3268,7 +5308,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -3439,6 +5479,91 @@

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. + "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. + "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. @@ -3458,6 +5583,91 @@

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. + "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. + "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. @@ -3471,6 +5681,91 @@

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. + "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. + "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. @@ -3537,6 +5832,91 @@

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. + "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. + "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. @@ -3556,6 +5936,91 @@

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. + "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. + "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. @@ -3569,6 +6034,91 @@

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. + "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. + "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. @@ -3675,7 +6225,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -3819,7 +6369,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -3870,7 +6420,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -3967,7 +6517,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. diff --git a/docs/dyn/aiplatform_v1beta1.publishers.models.html b/docs/dyn/aiplatform_v1beta1.publishers.models.html index c7c6871c460..d292f7abe13 100644 --- a/docs/dyn/aiplatform_v1beta1.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.publishers.models.html @@ -145,7 +145,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -233,7 +233,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -370,7 +370,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -696,7 +696,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -843,7 +843,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -1138,7 +1138,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -2670,7 +2670,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -2817,7 +2817,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -3112,7 +3112,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.html index b02cbd9d166..c5a0567e62d 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.html @@ -161,7 +161,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -409,7 +409,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -598,7 +598,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. @@ -792,7 +792,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.html index f7d53e66596..58c00d6551e 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.html @@ -228,7 +228,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.events.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.events.html index 645e765fb13..6cd8d6ca04a 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.events.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.events.html @@ -147,7 +147,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html index 96bf335ba10..b62e6dc9f75 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html @@ -151,7 +151,7 @@

Method 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", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + "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`. diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1.json index ed764a29a04..aa7b82d567a 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1.json @@ -20930,7 +20930,7 @@ } } }, -"revision": "20250916", +"revision": "20250920", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { @@ -21967,6 +21967,10 @@ "description": "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.", "type": "boolean" }, +"generationConfig": { +"$ref": "GoogleCloudAiplatformV1GenerationConfig", +"description": "Optional. Configuration options for model generation and outputs." +}, "samplingCount": { "description": "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.", "format": "int32", @@ -22664,7 +22668,7 @@ "type": "string" }, "rubricsColumn": { -"description": "Optional. The name of the column that contains the rubrics. This will be in evaluation_rubric.RubricGroup format (cl/762595858).", +"description": "Optional. The name of the column that contains the rubrics. This is in evaluation_rubric.RubricGroup format.", "type": "string" }, "samplingConfig": { @@ -26594,7 +26598,7 @@ "readOnly": true }, "gcsUri": { -"description": "The GCS object where the request or response is stored.", +"description": "The Cloud Storage object where the request or response is stored.", "type": "string" }, "labels": { @@ -29930,7 +29934,7 @@ "type": "object" }, "name": { -"description": "Required. The name of the function to call. Matches [FunctionDeclaration.name].", +"description": "Optional. The name of the function to call. Matches [FunctionDeclaration.name].", "type": "string" } }, @@ -33127,6 +33131,29 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1LustreMount": { +"description": "Represents a mount configuration for Lustre file system.", +"id": "GoogleCloudAiplatformV1LustreMount", +"properties": { +"filesystem": { +"description": "Required. The name of the Lustre filesystem.", +"type": "string" +}, +"instanceIp": { +"description": "Required. IP address of the Lustre instance.", +"type": "string" +}, +"mountPoint": { +"description": "Required. Destination mount path. The Lustre file system will be mounted for the user under /mnt/lustre/", +"type": "string" +}, +"volumeHandle": { +"description": "Required. The unique identifier of the Lustre volume.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1MachineSpec": { "description": "Specification of a single machine.", "id": "GoogleCloudAiplatformV1MachineSpec", @@ -33153,6 +33180,7 @@ "NVIDIA_H200_141GB", "NVIDIA_B200", "NVIDIA_GB200", +"NVIDIA_RTX_PRO_6000", "TPU_V2", "TPU_V3", "TPU_V4_POD", @@ -33176,6 +33204,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -33193,6 +33222,7 @@ false "Nvidia H200 141Gb GPU.", "Nvidia B200 GPU.", "Nvidia GB200 GPU.", +"Nvidia RTX Pro 6000 GPU.", "TPU v2.", "TPU v3.", "TPU v4.", @@ -49632,6 +49662,13 @@ false "$ref": "GoogleCloudAiplatformV1DiskSpec", "description": "Disk spec." }, +"lustreMounts": { +"description": "Optional. List of Lustre mounts.", +"items": { +"$ref": "GoogleCloudAiplatformV1LustreMount" +}, +"type": "array" +}, "machineSpec": { "$ref": "GoogleCloudAiplatformV1MachineSpec", "description": "Optional. Immutable. The specification of a single machine." diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json index 8fb059bc1cc..e68d2738ca1 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json @@ -26923,7 +26923,7 @@ } } }, -"revision": "20250916", +"revision": "20250920", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { @@ -28172,6 +28172,10 @@ "description": "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.", "type": "boolean" }, +"generationConfig": { +"$ref": "GoogleCloudAiplatformV1beta1GenerationConfig", +"description": "Optional. Configuration options for model generation and outputs." +}, "samplingCount": { "description": "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.", "format": "int32", @@ -28928,7 +28932,7 @@ "type": "string" }, "rubricsColumn": { -"description": "Optional. The name of the column that contains the rubrics. This will be in evaluation_rubric.RubricGroup format (cl/762595858).", +"description": "Optional. The name of the column that contains the rubrics. This is in evaluation_rubric.RubricGroup format.", "type": "string" }, "samplingConfig": { @@ -33340,7 +33344,7 @@ "readOnly": true }, "gcsUri": { -"description": "The GCS object where the request or response is stored.", +"description": "The Cloud Storage object where the request or response is stored.", "type": "string" }, "labels": { @@ -37513,7 +37517,7 @@ "type": "string" }, "name": { -"description": "Required. The name of the function to call. Matches [FunctionDeclaration.name].", +"description": "Optional. The name of the function to call. Matches [FunctionDeclaration.name].", "type": "string" } }, @@ -41421,6 +41425,29 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1LustreMount": { +"description": "Represents a mount configuration for Lustre file system.", +"id": "GoogleCloudAiplatformV1beta1LustreMount", +"properties": { +"filesystem": { +"description": "Required. The name of the Lustre filesystem.", +"type": "string" +}, +"instanceIp": { +"description": "Required. IP address of the Lustre instance.", +"type": "string" +}, +"mountPoint": { +"description": "Required. Destination mount path. The Lustre file system will be mounted for the user under /mnt/lustre/", +"type": "string" +}, +"volumeHandle": { +"description": "Required. The unique identifier of the Lustre volume.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1MachineSpec": { "description": "Specification of a single machine.", "id": "GoogleCloudAiplatformV1beta1MachineSpec", @@ -41447,6 +41474,7 @@ "NVIDIA_H200_141GB", "NVIDIA_B200", "NVIDIA_GB200", +"NVIDIA_RTX_PRO_6000", "TPU_V2", "TPU_V3", "TPU_V4_POD", @@ -41470,6 +41498,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -41487,6 +41516,7 @@ false "Nvidia H200 141Gb GPU.", "Nvidia B200 GPU.", "Nvidia GB200 GPU.", +"Nvidia RTX Pro 6000 GPU.", "TPU v2.", "TPU v3.", "TPU v4.", @@ -51526,6 +51556,11 @@ false "description": "Required. The display name of the SandboxEnvironment.", "type": "string" }, +"expireTime": { +"description": "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.", +"format": "google-datetime", +"type": "string" +}, "name": { "description": "Identifier. The name of the SandboxEnvironment.", "type": "string" @@ -51555,6 +51590,11 @@ false "readOnly": true, "type": "string" }, +"ttl": { +"description": "Optional. Input only. The TTL for the sandbox environment. The expiration time is computed: now + TTL.", +"format": "google-duration", +"type": "string" +}, "updateTime": { "description": "Output only. The timestamp when this SandboxEnvironment was most recently updated.", "format": "google-datetime", @@ -61188,6 +61228,13 @@ false "$ref": "GoogleCloudAiplatformV1beta1DiskSpec", "description": "Disk spec." }, +"lustreMounts": { +"description": "Optional. List of Lustre mounts.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1LustreMount" +}, +"type": "array" +}, "machineSpec": { "$ref": "GoogleCloudAiplatformV1beta1MachineSpec", "description": "Optional. Immutable. The specification of a single machine." From c5baca732c76b520dc2a3bd24d865150fc7241d2 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 30 Sep 2025 07:09:33 +0000 Subject: [PATCH 02/42] feat(alloydb): update the api #### alloydb:v1 The following keys were added: - schemas.ConnectionPoolConfig (Total Keys: 8) - schemas.Instance.properties.connectionPoolConfig.$ref (Total Keys: 1) #### alloydb:v1alpha The following keys were added: - schemas.ConnectionPoolConfig.properties.defaultPoolSize.deprecated (Total Keys: 1) - schemas.ConnectionPoolConfig.properties.enable.deprecated (Total Keys: 1) - schemas.ConnectionPoolConfig.properties.ignoreStartupParameters.deprecated (Total Keys: 1) - schemas.ConnectionPoolConfig.properties.maxClientConn.deprecated (Total Keys: 1) - schemas.ConnectionPoolConfig.properties.maxPreparedStatements.deprecated (Total Keys: 1) - schemas.ConnectionPoolConfig.properties.minPoolSize.deprecated (Total Keys: 1) - schemas.ConnectionPoolConfig.properties.poolMode.deprecated (Total Keys: 1) - schemas.ConnectionPoolConfig.properties.queryWaitTimeout.deprecated (Total Keys: 1) - schemas.ConnectionPoolConfig.properties.serverIdleTimeout.deprecated (Total Keys: 1) - schemas.ConnectionPoolConfig.properties.statsUsers.deprecated (Total Keys: 1) #### alloydb:v1beta The following keys were added: - schemas.ConnectionPoolConfig.properties.defaultPoolSize.deprecated (Total Keys: 1) - schemas.ConnectionPoolConfig.properties.enable.deprecated (Total Keys: 1) - schemas.ConnectionPoolConfig.properties.ignoreStartupParameters.deprecated (Total Keys: 1) - schemas.ConnectionPoolConfig.properties.maxClientConn.deprecated (Total Keys: 1) - schemas.ConnectionPoolConfig.properties.maxPreparedStatements.deprecated (Total Keys: 1) - schemas.ConnectionPoolConfig.properties.minPoolSize.deprecated (Total Keys: 1) - schemas.ConnectionPoolConfig.properties.poolMode.deprecated (Total Keys: 1) - schemas.ConnectionPoolConfig.properties.queryWaitTimeout.deprecated (Total Keys: 1) - schemas.ConnectionPoolConfig.properties.serverIdleTimeout.deprecated (Total Keys: 1) - schemas.ConnectionPoolConfig.properties.statsUsers.deprecated (Total Keys: 1) --- ...projects.locations.clusters.instances.html | 35 +++++++++++++++++ .../discovery_cache/documents/alloydb.v1.json | 38 +++++++++++++++++-- .../documents/alloydb.v1alpha.json | 20 ++++++++-- .../documents/alloydb.v1beta.json | 20 ++++++++-- 4 files changed, 101 insertions(+), 12 deletions(-) diff --git a/docs/dyn/alloydb_v1.projects.locations.clusters.instances.html b/docs/dyn/alloydb_v1.projects.locations.clusters.instances.html index d3e4f5970ac..cd358dc7ffa 100644 --- a/docs/dyn/alloydb_v1.projects.locations.clusters.instances.html +++ b/docs/dyn/alloydb_v1.projects.locations.clusters.instances.html @@ -138,6 +138,13 @@

Method Details

"sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior. }, }, + "connectionPoolConfig": { # Configuration for Managed Connection Pool (MCP). # Optional. The configuration for Managed Connection Pool (MCP). + "enabled": True or False, # Optional. Whether to enable Managed Connection Pool (MCP). + "flags": { # Optional. Connection Pool flags, as a list of "key": "value" pairs. + "a_key": "A String", + }, + "poolerCount": 42, # Output only. The number of running poolers per instance. + }, "createTime": "A String", # Output only. Create time stamp "databaseFlags": { # Database flags. Set at the instance level. They are copied from the primary instance on secondary instance creation. Flags that have restrictions default to the value at primary instance on read instances during creation. Read instances can set new flags or override existing flags that are relevant for reads, for example, for enabling columnar cache on a read instance. Flags set on read instance might or might not be present on the primary instance. This is a list of "key": "value" pairs. "key": The name of the flag. These flags are passed at instance setup time, so include both server options and system variables for Postgres. Flags are specified with underscores, not hyphens. "value": The value of the flag. Booleans are set to **on** for true and **off** for false. This field must be omitted if the flag doesn't take a value. "a_key": "A String", @@ -286,6 +293,13 @@

Method Details

"sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior. }, }, + "connectionPoolConfig": { # Configuration for Managed Connection Pool (MCP). # Optional. The configuration for Managed Connection Pool (MCP). + "enabled": True or False, # Optional. Whether to enable Managed Connection Pool (MCP). + "flags": { # Optional. Connection Pool flags, as a list of "key": "value" pairs. + "a_key": "A String", + }, + "poolerCount": 42, # Output only. The number of running poolers per instance. + }, "createTime": "A String", # Output only. Create time stamp "databaseFlags": { # Database flags. Set at the instance level. They are copied from the primary instance on secondary instance creation. Flags that have restrictions default to the value at primary instance on read instances during creation. Read instances can set new flags or override existing flags that are relevant for reads, for example, for enabling columnar cache on a read instance. Flags set on read instance might or might not be present on the primary instance. This is a list of "key": "value" pairs. "key": The name of the flag. These flags are passed at instance setup time, so include both server options and system variables for Postgres. Flags are specified with underscores, not hyphens. "value": The value of the flag. Booleans are set to **on** for true and **off** for false. This field must be omitted if the flag doesn't take a value. "a_key": "A String", @@ -525,6 +539,13 @@

Method Details

"sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior. }, }, + "connectionPoolConfig": { # Configuration for Managed Connection Pool (MCP). # Optional. The configuration for Managed Connection Pool (MCP). + "enabled": True or False, # Optional. Whether to enable Managed Connection Pool (MCP). + "flags": { # Optional. Connection Pool flags, as a list of "key": "value" pairs. + "a_key": "A String", + }, + "poolerCount": 42, # Output only. The number of running poolers per instance. + }, "createTime": "A String", # Output only. Create time stamp "databaseFlags": { # Database flags. Set at the instance level. They are copied from the primary instance on secondary instance creation. Flags that have restrictions default to the value at primary instance on read instances during creation. Read instances can set new flags or override existing flags that are relevant for reads, for example, for enabling columnar cache on a read instance. Flags set on read instance might or might not be present on the primary instance. This is a list of "key": "value" pairs. "key": The name of the flag. These flags are passed at instance setup time, so include both server options and system variables for Postgres. Flags are specified with underscores, not hyphens. "value": The value of the flag. Booleans are set to **on** for true and **off** for false. This field must be omitted if the flag doesn't take a value. "a_key": "A String", @@ -720,6 +741,13 @@

Method Details

"sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior. }, }, + "connectionPoolConfig": { # Configuration for Managed Connection Pool (MCP). # Optional. The configuration for Managed Connection Pool (MCP). + "enabled": True or False, # Optional. Whether to enable Managed Connection Pool (MCP). + "flags": { # Optional. Connection Pool flags, as a list of "key": "value" pairs. + "a_key": "A String", + }, + "poolerCount": 42, # Output only. The number of running poolers per instance. + }, "createTime": "A String", # Output only. Create time stamp "databaseFlags": { # Database flags. Set at the instance level. They are copied from the primary instance on secondary instance creation. Flags that have restrictions default to the value at primary instance on read instances during creation. Read instances can set new flags or override existing flags that are relevant for reads, for example, for enabling columnar cache on a read instance. Flags set on read instance might or might not be present on the primary instance. This is a list of "key": "value" pairs. "key": The name of the flag. These flags are passed at instance setup time, so include both server options and system variables for Postgres. Flags are specified with underscores, not hyphens. "value": The value of the flag. Booleans are set to **on** for true and **off** for false. This field must be omitted if the flag doesn't take a value. "a_key": "A String", @@ -857,6 +885,13 @@

Method Details

"sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior. }, }, + "connectionPoolConfig": { # Configuration for Managed Connection Pool (MCP). # Optional. The configuration for Managed Connection Pool (MCP). + "enabled": True or False, # Optional. Whether to enable Managed Connection Pool (MCP). + "flags": { # Optional. Connection Pool flags, as a list of "key": "value" pairs. + "a_key": "A String", + }, + "poolerCount": 42, # Output only. The number of running poolers per instance. + }, "createTime": "A String", # Output only. Create time stamp "databaseFlags": { # Database flags. Set at the instance level. They are copied from the primary instance on secondary instance creation. Flags that have restrictions default to the value at primary instance on read instances during creation. Read instances can set new flags or override existing flags that are relevant for reads, for example, for enabling columnar cache on a read instance. Flags set on read instance might or might not be present on the primary instance. This is a list of "key": "value" pairs. "key": The name of the flag. These flags are passed at instance setup time, so include both server options and system variables for Postgres. Flags are specified with underscores, not hyphens. "value": The value of the flag. Booleans are set to **on** for true and **off** for false. This field must be omitted if the flag doesn't take a value. "a_key": "A String", diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1.json b/googleapiclient/discovery_cache/documents/alloydb.v1.json index 70b968e6425..55fdaeb3a70 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1.json @@ -1622,7 +1622,7 @@ } } }, -"revision": "20250904", +"revision": "20250910", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -2308,6 +2308,30 @@ false }, "type": "object" }, +"ConnectionPoolConfig": { +"description": "Configuration for Managed Connection Pool (MCP).", +"id": "ConnectionPoolConfig", +"properties": { +"enabled": { +"description": "Optional. Whether to enable Managed Connection Pool (MCP).", +"type": "boolean" +}, +"flags": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Connection Pool flags, as a list of \"key\": \"value\" pairs.", +"type": "object" +}, +"poolerCount": { +"description": "Output only. The number of running poolers per instance.", +"format": "int32", +"readOnly": true, +"type": "integer" +} +}, +"type": "object" +}, "ContinuousBackupConfig": { "description": "ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster.", "id": "ContinuousBackupConfig", @@ -2785,6 +2809,10 @@ false "$ref": "ClientConnectionConfig", "description": "Optional. Client connection specific configurations" }, +"connectionPoolConfig": { +"$ref": "ConnectionPoolConfig", +"description": "Optional. The configuration for Managed Connection Pool (MCP)." +}, "createTime": { "description": "Output only. Create time stamp", "format": "google-datetime", @@ -4252,7 +4280,7 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed": { -"description": "DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. Next ID: 12", +"description": "DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. Next ID: 13", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed", "properties": { "backupdrMetadata": { @@ -4281,7 +4309,8 @@ false "SECURITY_FINDING_DATA", "RECOMMENDATION_SIGNAL_DATA", "CONFIG_BASED_SIGNAL_DATA", -"BACKUPDR_METADATA" +"BACKUPDR_METADATA", +"DATABASE_RESOURCE_SIGNAL_DATA" ], "enumDescriptions": [ "", @@ -4290,7 +4319,8 @@ false "Database resource security health signal data", "Database resource recommendation signal data", "Database config based signal data", -"Database resource metadata from BackupDR" +"Database resource metadata from BackupDR", +"Database resource signal data" ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json b/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json index afcf52ebc7f..b820349c516 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json @@ -1622,7 +1622,7 @@ } } }, -"revision": "20250904", +"revision": "20250910", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -2347,10 +2347,12 @@ false "id": "ConnectionPoolConfig", "properties": { "defaultPoolSize": { +"deprecated": true, "description": "Optional. Deprecated. Use 'flags' instead. The default pool size. Defaults to 20. Note: This field should not be added to client libraries if not present already.", "type": "string" }, "enable": { +"deprecated": true, "description": "Optional. Deprecated; Prefer 'enabled' as this will be removed soon.", "type": "boolean" }, @@ -2366,6 +2368,7 @@ false "type": "object" }, "ignoreStartupParameters": { +"deprecated": true, "description": "Optional. Deprecated. Use 'flags' instead. The list of startup parameters to ignore. Defaults to [\"extra_float_digits\"] Note: This field should not be added to client libraries if not present already.", "items": { "type": "string" @@ -2373,18 +2376,22 @@ false "type": "array" }, "maxClientConn": { +"deprecated": true, "description": "Optional. Deprecated. Use 'flags' instead. The maximum number of client connections allowed. Note: This field should not be added to client libraries if not present already.", "type": "string" }, "maxPreparedStatements": { +"deprecated": true, "description": "Optional. Deprecated. Use 'flags' instead. The maximum number of prepared statements allowed. MCP makes sure that any statement prepared by a client, up to this limit, is available on the backing server connection in transaction and statement pooling mode. Even if the statement was originally prepared on another server connection. Defaults to 0. Note: This field should not be added to client libraries if not present already.", "type": "string" }, "minPoolSize": { +"deprecated": true, "description": "Optional. Deprecated. Use 'flags' instead. The minimum pool size. Defaults to 0. Note: This field should not be added to client libraries if not present already.", "type": "string" }, "poolMode": { +"deprecated": true, "description": "Optional. Deprecated. Use 'flags' instead. The pool mode. Defaults to `POOL_MODE_TRANSACTION`. Note: This field should not be added to client libraries if not present already.", "enum": [ "POOL_MODE_UNSPECIFIED", @@ -2405,14 +2412,17 @@ false "type": "integer" }, "queryWaitTimeout": { +"deprecated": true, "description": "Optional. Deprecated. Use 'flags' instead. The maximum number of seconds queries are allowed to spend waiting for execution. If the query is not assigned to a server during that time, the client is disconnected. 0 disables. Note: This field should not be added to client libraries if not present already.", "type": "string" }, "serverIdleTimeout": { +"deprecated": true, "description": "Optional. Deprecated. Use 'flags' instead. The maximum number of seconds a server is allowed to be idle before it is disconnected. 0 disables. Note: This field should not be added to client libraries if not present already.", "type": "string" }, "statsUsers": { +"deprecated": true, "description": "Optional. Deprecated. Use 'flags' instead. The list of users that are allowed to connect to the MCP stats console. The users must exist in the database. Note: This field should not be added to client libraries if not present already.", "items": { "type": "string" @@ -4420,7 +4430,7 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed": { -"description": "DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. Next ID: 12", +"description": "DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. Next ID: 13", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed", "properties": { "backupdrMetadata": { @@ -4449,7 +4459,8 @@ false "SECURITY_FINDING_DATA", "RECOMMENDATION_SIGNAL_DATA", "CONFIG_BASED_SIGNAL_DATA", -"BACKUPDR_METADATA" +"BACKUPDR_METADATA", +"DATABASE_RESOURCE_SIGNAL_DATA" ], "enumDescriptions": [ "", @@ -4458,7 +4469,8 @@ false "Database resource security health signal data", "Database resource recommendation signal data", "Database config based signal data", -"Database resource metadata from BackupDR" +"Database resource metadata from BackupDR", +"Database resource signal data" ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1beta.json b/googleapiclient/discovery_cache/documents/alloydb.v1beta.json index 3b34e4ee837..83f522a0645 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1beta.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1beta.json @@ -1619,7 +1619,7 @@ } } }, -"revision": "20250904", +"revision": "20250910", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -2328,10 +2328,12 @@ false "id": "ConnectionPoolConfig", "properties": { "defaultPoolSize": { +"deprecated": true, "description": "Optional. Deprecated. Use 'flags' instead. The default pool size. Defaults to 20. Note: This field should not be added to client libraries if not present already.", "type": "string" }, "enable": { +"deprecated": true, "description": "Optional. Deprecated; Prefer 'enabled' as this will be removed soon.", "type": "boolean" }, @@ -2347,6 +2349,7 @@ false "type": "object" }, "ignoreStartupParameters": { +"deprecated": true, "description": "Optional. Deprecated. Use 'flags' instead. The list of startup parameters to ignore. Defaults to [\"extra_float_digits\"] Note: This field should not be added to client libraries if not present already.", "items": { "type": "string" @@ -2354,18 +2357,22 @@ false "type": "array" }, "maxClientConn": { +"deprecated": true, "description": "Optional. Deprecated. Use 'flags' instead. The maximum number of client connections allowed. Note: This field should not be added to client libraries if not present already.", "type": "string" }, "maxPreparedStatements": { +"deprecated": true, "description": "Optional. Deprecated. Use 'flags' instead. The maximum number of prepared statements allowed. MCP makes sure that any statement prepared by a client, up to this limit, is available on the backing server connection in transaction and statement pooling mode. Even if the statement was originally prepared on another server connection. Defaults to 0. Note: This field should not be added to client libraries if not present already.", "type": "string" }, "minPoolSize": { +"deprecated": true, "description": "Optional. Deprecated. Use 'flags' instead. The minimum pool size. Defaults to 0. Note: This field should not be added to client libraries if not present already.", "type": "string" }, "poolMode": { +"deprecated": true, "description": "Optional. Deprecated. Use 'flags' instead. The pool mode. Defaults to `POOL_MODE_TRANSACTION`. Note: This field should not be added to client libraries if not present already.", "enum": [ "POOL_MODE_UNSPECIFIED", @@ -2386,14 +2393,17 @@ false "type": "integer" }, "queryWaitTimeout": { +"deprecated": true, "description": "Optional. Deprecated. Use 'flags' instead. The maximum number of seconds queries are allowed to spend waiting for execution. If the query is not assigned to a server during that time, the client is disconnected. 0 disables. Note: This field should not be added to client libraries if not present already.", "type": "string" }, "serverIdleTimeout": { +"deprecated": true, "description": "Optional. Deprecated. Use 'flags' instead. The maximum number of seconds a server is allowed to be idle before it is disconnected. 0 disables. Note: This field should not be added to client libraries if not present already.", "type": "string" }, "statsUsers": { +"deprecated": true, "description": "Optional. Deprecated. Use 'flags' instead. The list of users that are allowed to connect to the MCP stats console. The users must exist in the database. Note: This field should not be added to client libraries if not present already.", "items": { "type": "string" @@ -4396,7 +4406,7 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed": { -"description": "DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. Next ID: 12", +"description": "DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. Next ID: 13", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed", "properties": { "backupdrMetadata": { @@ -4425,7 +4435,8 @@ false "SECURITY_FINDING_DATA", "RECOMMENDATION_SIGNAL_DATA", "CONFIG_BASED_SIGNAL_DATA", -"BACKUPDR_METADATA" +"BACKUPDR_METADATA", +"DATABASE_RESOURCE_SIGNAL_DATA" ], "enumDescriptions": [ "", @@ -4434,7 +4445,8 @@ false "Database resource security health signal data", "Database resource recommendation signal data", "Database config based signal data", -"Database resource metadata from BackupDR" +"Database resource metadata from BackupDR", +"Database resource signal data" ], "type": "string" }, From 37d9cacc272e0c7d063c798538017f5d93928349 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 30 Sep 2025 07:09:34 +0000 Subject: [PATCH 03/42] feat(androidmanagement): update the api #### androidmanagement:v1 The following keys were added: - resources.enterprises.resources.devices.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - schemas.ListOperationsResponse.properties.unreachable (Total Keys: 2) --- ...nagement_v1.enterprises.devices.operations.html | 8 ++++++-- .../documents/androidmanagement.v1.json | 14 +++++++++++++- 2 files changed, 19 insertions(+), 3 deletions(-) diff --git a/docs/dyn/androidmanagement_v1.enterprises.devices.operations.html b/docs/dyn/androidmanagement_v1.enterprises.devices.operations.html index cfdc1e8eaa4..709f3b848f0 100644 --- a/docs/dyn/androidmanagement_v1.enterprises.devices.operations.html +++ b/docs/dyn/androidmanagement_v1.enterprises.devices.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/androidmanagement.v1.json b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json index 625d60c2caa..c229d0dc720 100644 --- a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json @@ -598,6 +598,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}", @@ -1260,7 +1265,7 @@ } } }, -"revision": "20250916", +"revision": "20250924", "rootUrl": "https://androidmanagement.googleapis.com/", "schemas": { "AdbShellCommandEvent": { @@ -4740,6 +4745,13 @@ false "$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 9442d50d83d99779978ad8c78f060d7dd81875a9 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 30 Sep 2025 07:09:34 +0000 Subject: [PATCH 04/42] feat(backupdr): update the api #### backupdr:v1 The following keys were added: - schemas.AlloyDBClusterDataSourceProperties (Total Keys: 4) - schemas.AlloyDbClusterBackupProperties (Total Keys: 9) - schemas.Backup.properties.alloyDbBackupProperties (Total Keys: 2) - schemas.DataSourceGcpResource.properties.alloyDbClusterDatasourceProperties (Total Keys: 2) --- ...ions.backupVaults.dataSources.backups.html | 18 ++++++ ...ts.locations.backupVaults.dataSources.html | 9 +++ docs/dyn/backupdr_v1.projects.locations.html | 2 +- .../backupdr_v1.projects.locations.trial.html | 2 +- .../documents/backupdr.v1.json | 55 ++++++++++++++++++- 5 files changed, 81 insertions(+), 5 deletions(-) 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 aa2591ad3b7..16bfd0bce2c 100644 --- a/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.backups.html +++ b/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.backups.html @@ -157,6 +157,12 @@

Method Details

An object of the form: { # 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). @@ -422,6 +428,12 @@

Method Details

{ # Response message for listing Backups. "backups": [ # The list of Backup instances in the project for the specified location. If the '{location}' value in the request is "-", the response contains a list of instances from all locations. In case any location is unreachable, the response will only return data sources in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations. { # 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). @@ -691,6 +703,12 @@

Method Details

The object takes the form of: { # 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). diff --git a/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.html b/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.html index 03a0bf80e49..517d1a83309 100644 --- a/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.html +++ b/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.html @@ -298,6 +298,9 @@

Method Details

"type": "A String", # The type of the application. e.g. VMBackup }, "dataSourceGcpResource": { # DataSourceGcpResource is used for protected resources that are Google Cloud Resources. This name is easeier to understand than GcpResourceDataSource or GcpDataSourceResource # The backed up resource is a Google Cloud resource. The word 'DataSource' was included in the names to indicate that this is the representation of the Google Cloud resource used within the DataSource object. + "alloyDbClusterDatasourceProperties": { # AlloyDBClusterDataSourceProperties represents the properties of a AlloyDB cluster resource that are stored in the DataSource. . # Output only. AlloyDBClusterDataSourceProperties has a subset of AlloyDB cluster properties that are useful at the Datasource level. Currently none of its child properties are auditable. If new auditable properties are added, the AUDIT annotation should be added. + "name": "A String", # Output only. Name of the AlloyDB cluster backed up by the datasource. + }, "cloudSqlInstanceDatasourceProperties": { # CloudSqlInstanceDataSourceProperties represents the properties of a Cloud SQL resource that are stored in the DataSource. # Output only. CloudSqlInstanceDataSourceProperties has a subset of Cloud SQL Instance properties that are useful at the Datasource level. "databaseInstalledVersion": "A String", # Output only. The installed database version of the Cloud SQL instance. "instanceCreateTime": "A String", # Output only. The instance creation timestamp. @@ -428,6 +431,9 @@

Method Details

"type": "A String", # The type of the application. e.g. VMBackup }, "dataSourceGcpResource": { # DataSourceGcpResource is used for protected resources that are Google Cloud Resources. This name is easeier to understand than GcpResourceDataSource or GcpDataSourceResource # The backed up resource is a Google Cloud resource. The word 'DataSource' was included in the names to indicate that this is the representation of the Google Cloud resource used within the DataSource object. + "alloyDbClusterDatasourceProperties": { # AlloyDBClusterDataSourceProperties represents the properties of a AlloyDB cluster resource that are stored in the DataSource. . # Output only. AlloyDBClusterDataSourceProperties has a subset of AlloyDB cluster properties that are useful at the Datasource level. Currently none of its child properties are auditable. If new auditable properties are added, the AUDIT annotation should be added. + "name": "A String", # Output only. Name of the AlloyDB cluster backed up by the datasource. + }, "cloudSqlInstanceDatasourceProperties": { # CloudSqlInstanceDataSourceProperties represents the properties of a Cloud SQL resource that are stored in the DataSource. # Output only. CloudSqlInstanceDataSourceProperties has a subset of Cloud SQL Instance properties that are useful at the Datasource level. "databaseInstalledVersion": "A String", # Output only. The installed database version of the Cloud SQL instance. "instanceCreateTime": "A String", # Output only. The instance creation timestamp. @@ -538,6 +544,9 @@

Method Details

"type": "A String", # The type of the application. e.g. VMBackup }, "dataSourceGcpResource": { # DataSourceGcpResource is used for protected resources that are Google Cloud Resources. This name is easeier to understand than GcpResourceDataSource or GcpDataSourceResource # The backed up resource is a Google Cloud resource. The word 'DataSource' was included in the names to indicate that this is the representation of the Google Cloud resource used within the DataSource object. + "alloyDbClusterDatasourceProperties": { # AlloyDBClusterDataSourceProperties represents the properties of a AlloyDB cluster resource that are stored in the DataSource. . # Output only. AlloyDBClusterDataSourceProperties has a subset of AlloyDB cluster properties that are useful at the Datasource level. Currently none of its child properties are auditable. If new auditable properties are added, the AUDIT annotation should be added. + "name": "A String", # Output only. Name of the AlloyDB cluster backed up by the datasource. + }, "cloudSqlInstanceDatasourceProperties": { # CloudSqlInstanceDataSourceProperties represents the properties of a Cloud SQL resource that are stored in the DataSource. # Output only. CloudSqlInstanceDataSourceProperties has a subset of Cloud SQL Instance properties that are useful at the Datasource level. "databaseInstalledVersion": "A String", # Output only. The installed database version of the Cloud SQL instance. "instanceCreateTime": "A String", # Output only. The instance creation timestamp. diff --git a/docs/dyn/backupdr_v1.projects.locations.html b/docs/dyn/backupdr_v1.projects.locations.html index e0dd4d739c3..6767c8b8842 100644 --- a/docs/dyn/backupdr_v1.projects.locations.html +++ b/docs/dyn/backupdr_v1.projects.locations.html @@ -172,7 +172,7 @@

Method Details

Gets the Trial state for a given project
 
 Args:
-  name: string, Required. The name of the trial to retrieve. (required)
+  name: string, Required. The project for which trial details need to be retrieved. Format: projects/{project}/locations/{location} Supported Locations are - us, eu and asia. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
diff --git a/docs/dyn/backupdr_v1.projects.locations.trial.html b/docs/dyn/backupdr_v1.projects.locations.trial.html
index caca1e91569..8ab3f5e9cf3 100644
--- a/docs/dyn/backupdr_v1.projects.locations.trial.html
+++ b/docs/dyn/backupdr_v1.projects.locations.trial.html
@@ -91,7 +91,7 @@ 
Method Details

   
Subscribes to a trial for a project
 
 Args:
-  parent: string, Required. The parent resource where this trial will be created. (required)
+  parent: string, Required. The project where this trial will be created. Format: projects/{project}/locations/{location} Supported Locations are - us, eu and asia. (required)
   body: object, The request body.
     The object takes the form of:
 
diff --git a/googleapiclient/discovery_cache/documents/backupdr.v1.json b/googleapiclient/discovery_cache/documents/backupdr.v1.json
index 3209a4a4c77..2e5ec22d76d 100644
--- a/googleapiclient/discovery_cache/documents/backupdr.v1.json
+++ b/googleapiclient/discovery_cache/documents/backupdr.v1.json
@@ -144,7 +144,7 @@
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the trial to retrieve.",
+"description": "Required. The project for which trial details need to be retrieved. Format: projects/{project}/locations/{location} Supported Locations are - us, eu and asia.",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+/trial$",
 "required": true,
@@ -2092,7 +2092,7 @@
 ],
 "parameters": {
 "parent": {
-"description": "Required. The parent resource where this trial will be created.",
+"description": "Required. The project where this trial will be created. Format: projects/{project}/locations/{location} Supported Locations are - us, eu and asia.",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
@@ -2117,7 +2117,7 @@
 }
 }
 },
-"revision": "20250910",
+"revision": "20250916",
 "rootUrl": "https://backupdr.googleapis.com/",
 "schemas": {
 "AbandonBackupRequest": {
@@ -2281,6 +2281,45 @@
 },
 "type": "object"
 },
+"AlloyDBClusterDataSourceProperties": {
+"description": "AlloyDBClusterDataSourceProperties represents the properties of a AlloyDB cluster resource that are stored in the DataSource. .",
+"id": "AlloyDBClusterDataSourceProperties",
+"properties": {
+"name": {
+"description": "Output only. Name of the AlloyDB cluster backed up by the datasource.",
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
+"AlloyDbClusterBackupProperties": {
+"description": "AlloyDbClusterBackupProperties represents AlloyDB cluster backup properties. .",
+"id": "AlloyDbClusterBackupProperties",
+"properties": {
+"chainId": {
+"description": "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.",
+"readOnly": true,
+"type": "string"
+},
+"databaseVersion": {
+"description": "Output only. The PostgreSQL major version of the AlloyDB cluster when the backup was taken.",
+"readOnly": true,
+"type": "string"
+},
+"description": {
+"description": "An optional text description for the backup.",
+"type": "string"
+},
+"storedBytes": {
+"description": "Output only. Storage usage of this particular backup",
+"format": "int64",
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
 "AttachedDisk": {
 "description": "An instance-attached disk resource.",
 "id": "AttachedDisk",
@@ -2473,6 +2512,11 @@
 "description": "Message describing a Backup object.",
 "id": "Backup",
 "properties": {
+"alloyDbBackupProperties": {
+"$ref": "AlloyDbClusterBackupProperties",
+"description": "Output only. AlloyDB specific backup properties.",
+"readOnly": true
+},
 "backupApplianceBackupProperties": {
 "$ref": "BackupApplianceBackupProperties",
 "description": "Output only. Backup Appliance specific backup properties.",
@@ -3973,6 +4017,11 @@
 "description": "DataSourceGcpResource is used for protected resources that are Google Cloud Resources. This name is easeier to understand than GcpResourceDataSource or GcpDataSourceResource",
 "id": "DataSourceGcpResource",
 "properties": {
+"alloyDbClusterDatasourceProperties": {
+"$ref": "AlloyDBClusterDataSourceProperties",
+"description": "Output only. AlloyDBClusterDataSourceProperties has a subset of AlloyDB cluster properties that are useful at the Datasource level. Currently none of its child properties are auditable. If new auditable properties are added, the AUDIT annotation should be added.",
+"readOnly": true
+},
 "cloudSqlInstanceDatasourceProperties": {
 "$ref": "CloudSqlInstanceDataSourceProperties",
 "description": "Output only. CloudSqlInstanceDataSourceProperties has a subset of Cloud SQL Instance properties that are useful at the Datasource level.",

From 1c7b14beaec6527f9d5ee94b8c25834530d550f8 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 30 Sep 2025 07:09:34 +0000
Subject: [PATCH 05/42] feat(beyondcorp): update the api

#### beyondcorp:v1

The following keys were added:
- schemas.GoogleCloudBeyondcorpSecuritygatewaysV1Application.properties.schema.type (Total Keys: 1)
- schemas.GoogleCloudBeyondcorpSecuritygatewaysV1ApplicationUpstream.properties.external.$ref (Total Keys: 1)
- schemas.GoogleCloudBeyondcorpSecuritygatewaysV1ApplicationUpstream.properties.proxyProtocol.$ref (Total Keys: 1)
- schemas.GoogleCloudBeyondcorpSecuritygatewaysV1ApplicationUpstreamExternal (Total Keys: 4)
- schemas.GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeaders (Total Keys: 15)
- schemas.GoogleCloudBeyondcorpSecuritygatewaysV1Endpoint (Total Keys: 5)
- schemas.GoogleCloudBeyondcorpSecuritygatewaysV1ProxyProtocolConfig (Total Keys: 9)
- schemas.GoogleCloudBeyondcorpSecuritygatewaysV1SecurityGateway.properties.proxyProtocolConfig.$ref (Total Keys: 1)
- schemas.GoogleCloudBeyondcorpSecuritygatewaysV1SecurityGateway.properties.serviceDiscovery.$ref (Total Keys: 1)
- schemas.GoogleCloudBeyondcorpSecuritygatewaysV1ServiceDiscovery (Total Keys: 9)

#### beyondcorp:v1alpha

The following keys were added:
- schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplication.properties.schema.type (Total Keys: 1)
- schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplicationUpstream.properties.external.$ref (Total Keys: 1)
- schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplicationUpstream.properties.proxyProtocol.$ref (Total Keys: 1)
- schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplicationUpstreamExternal (Total Keys: 4)
- schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaContextualHeaders (Total Keys: 15)
- schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaEndpoint (Total Keys: 5)
- schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaProxyProtocolConfig (Total Keys: 9)
- schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway.properties.proxyProtocolConfig.$ref (Total Keys: 1)
- schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway.properties.serviceDiscovery.$ref (Total Keys: 1)
- schemas.GoogleCloudBeyondcorpSecuritygatewaysV1alphaServiceDiscovery (Total Keys: 9)
---
 ...cations.securityGateways.applications.html | 140 +++++++++-
 ...1.projects.locations.securityGateways.html | 116 +++++++++
 ...cations.securityGateways.applications.html | 140 +++++++++-
 ...a.projects.locations.securityGateways.html | 116 +++++++++
 .../documents/beyondcorp.v1.json              | 244 +++++++++++++++++-
 .../documents/beyondcorp.v1alpha.json         | 244 +++++++++++++++++-
 6 files changed, 978 insertions(+), 22 deletions(-)

diff --git a/docs/dyn/beyondcorp_v1.projects.locations.securityGateways.applications.html b/docs/dyn/beyondcorp_v1.projects.locations.securityGateways.applications.html
index 61e0ca48bcd..3defac03eaa 100644
--- a/docs/dyn/beyondcorp_v1.projects.locations.securityGateways.applications.html
+++ b/docs/dyn/beyondcorp_v1.projects.locations.securityGateways.applications.html
@@ -122,15 +122,16 @@ 
Method Details

 { # The information about an application resource.
   "createTime": "A String", # Output only. Timestamp when the resource was created.
   "displayName": "A String", # Optional. An arbitrary user-provided name for the application resource. Cannot exceed 64 characters.
-  "endpointMatchers": [ # Required. Endpoint matchers associated with an application. A combination of hostname and ports as endpoint matchers is used to match the application. Match conditions for OR logic. An array of match conditions to allow for multiple matching criteria. The rule is considered a match if one of the conditions is met. The conditions can be one of the following combinations (Hostname), (Hostname & Ports) EXAMPLES: Hostname - ("*.example.com"), ("xyz.example.com") Hostname and Ports - ("example.com" and "22"), ("example.com" and "22,33") etc
+  "endpointMatchers": [ # Required. Endpoint matchers associated with an application. A combination of hostname and ports as endpoint matchers is used to match the application. Match conditions for OR logic. An array of match conditions to allow for multiple matching criteria. The rule is considered a match if one of the conditions is met. The conditions should be the following combination: (Hostname & Ports) EXAMPLES: Hostname and Ports - ("*.example.com", "443"), ("example.com" and "22"), ("example.com" and "22,33") etc
     { # EndpointMatcher contains the information of the endpoint that will match the application.
       "hostname": "A String", # Required. Hostname of the application.
-      "ports": [ # Optional. Ports of the application.
+      "ports": [ # Required. Ports of the application.
         42,
       ],
     },
   ],
   "name": "A String", # Identifier. Name of the resource.
+  "schema": "A String", # Optional. Type of the external application.
   "updateTime": "A String", # Output only. Timestamp when the resource was last modified.
   "upstreams": [ # Optional. Which upstream resources to forward traffic to.
     { # Which upstream resource to forward traffic to.
@@ -139,9 +140,39 @@ 
Method Details

           "A String",
         ],
       },
+      "external": { # Endpoints to forward traffic to. # List of the external endpoints to forward traffic to.
+        "endpoints": [ # Required. List of the endpoints to forward traffic to.
+          { # Internet Gateway endpoint to forward traffic to.
+            "hostname": "A String", # Required. Hostname of the endpoint.
+            "port": 42, # Required. Port of the endpoint.
+          },
+        ],
+      },
       "network": { # Network to forward traffic to. # Network to forward traffic to.
         "name": "A String", # Required. Network name is of the format: `projects/{project}/global/networks/{network}
       },
+      "proxyProtocol": { # The configuration for the proxy. # Optional. Enables proxy protocol configuration for the upstream.
+        "allowedClientHeaders": [ # Optional. List of the allowed client header names.
+          "A String",
+        ],
+        "clientIp": True or False, # Optional. Client IP configuration. The client IP address is included if true.
+        "contextualHeaders": { # Contextual headers configuration. # Optional. Configuration for the contextual headers.
+          "deviceInfo": { # Delegated device info configuration. # Optional. Device info configuration.
+            "outputType": "A String", # Optional. The output type of the delegated device info.
+          },
+          "groupInfo": { # Delegated group info configuration. # Optional. Group info configuration.
+            "outputType": "A String", # Optional. The output type of the delegated group info.
+          },
+          "outputType": "A String", # Optional. Default output type for all enabled headers.
+          "userInfo": { # Delegated user info configuration. # Optional. User info configuration.
+            "outputType": "A String", # Optional. The output type of the delegated user info.
+          },
+        },
+        "gatewayIdentity": "A String", # Optional. Gateway identity configuration.
+        "metadataHeaders": { # Optional. Custom resource specific headers along with the values. The names should conform to RFC 9110: > Field names SHOULD constrain themselves to alphanumeric characters, "-", and ".", and SHOULD begin with a letter. Field values SHOULD contain only ASCII printable characters and tab.
+          "a_key": "A String",
+        },
+      },
     },
   ],
 }
@@ -231,15 +262,16 @@ 
Method Details

     { # The information about an application resource.
   "createTime": "A String", # Output only. Timestamp when the resource was created.
   "displayName": "A String", # Optional. An arbitrary user-provided name for the application resource. Cannot exceed 64 characters.
-  "endpointMatchers": [ # Required. Endpoint matchers associated with an application. A combination of hostname and ports as endpoint matchers is used to match the application. Match conditions for OR logic. An array of match conditions to allow for multiple matching criteria. The rule is considered a match if one of the conditions is met. The conditions can be one of the following combinations (Hostname), (Hostname & Ports) EXAMPLES: Hostname - ("*.example.com"), ("xyz.example.com") Hostname and Ports - ("example.com" and "22"), ("example.com" and "22,33") etc
+  "endpointMatchers": [ # Required. Endpoint matchers associated with an application. A combination of hostname and ports as endpoint matchers is used to match the application. Match conditions for OR logic. An array of match conditions to allow for multiple matching criteria. The rule is considered a match if one of the conditions is met. The conditions should be the following combination: (Hostname & Ports) EXAMPLES: Hostname and Ports - ("*.example.com", "443"), ("example.com" and "22"), ("example.com" and "22,33") etc
     { # EndpointMatcher contains the information of the endpoint that will match the application.
       "hostname": "A String", # Required. Hostname of the application.
-      "ports": [ # Optional. Ports of the application.
+      "ports": [ # Required. Ports of the application.
         42,
       ],
     },
   ],
   "name": "A String", # Identifier. Name of the resource.
+  "schema": "A String", # Optional. Type of the external application.
   "updateTime": "A String", # Output only. Timestamp when the resource was last modified.
   "upstreams": [ # Optional. Which upstream resources to forward traffic to.
     { # Which upstream resource to forward traffic to.
@@ -248,9 +280,39 @@ 
Method Details

           "A String",
         ],
       },
+      "external": { # Endpoints to forward traffic to. # List of the external endpoints to forward traffic to.
+        "endpoints": [ # Required. List of the endpoints to forward traffic to.
+          { # Internet Gateway endpoint to forward traffic to.
+            "hostname": "A String", # Required. Hostname of the endpoint.
+            "port": 42, # Required. Port of the endpoint.
+          },
+        ],
+      },
       "network": { # Network to forward traffic to. # Network to forward traffic to.
         "name": "A String", # Required. Network name is of the format: `projects/{project}/global/networks/{network}
       },
+      "proxyProtocol": { # The configuration for the proxy. # Optional. Enables proxy protocol configuration for the upstream.
+        "allowedClientHeaders": [ # Optional. List of the allowed client header names.
+          "A String",
+        ],
+        "clientIp": True or False, # Optional. Client IP configuration. The client IP address is included if true.
+        "contextualHeaders": { # Contextual headers configuration. # Optional. Configuration for the contextual headers.
+          "deviceInfo": { # Delegated device info configuration. # Optional. Device info configuration.
+            "outputType": "A String", # Optional. The output type of the delegated device info.
+          },
+          "groupInfo": { # Delegated group info configuration. # Optional. Group info configuration.
+            "outputType": "A String", # Optional. The output type of the delegated group info.
+          },
+          "outputType": "A String", # Optional. Default output type for all enabled headers.
+          "userInfo": { # Delegated user info configuration. # Optional. User info configuration.
+            "outputType": "A String", # Optional. The output type of the delegated user info.
+          },
+        },
+        "gatewayIdentity": "A String", # Optional. Gateway identity configuration.
+        "metadataHeaders": { # Optional. Custom resource specific headers along with the values. The names should conform to RFC 9110: > Field names SHOULD constrain themselves to alphanumeric characters, "-", and ".", and SHOULD begin with a letter. Field values SHOULD contain only ASCII printable characters and tab.
+          "a_key": "A String",
+        },
+      },
     },
   ],
 }

@@ -327,15 +389,16 @@ 
Method Details

     { # The information about an application resource.
       "createTime": "A String", # Output only. Timestamp when the resource was created.
       "displayName": "A String", # Optional. An arbitrary user-provided name for the application resource. Cannot exceed 64 characters.
-      "endpointMatchers": [ # Required. Endpoint matchers associated with an application. A combination of hostname and ports as endpoint matchers is used to match the application. Match conditions for OR logic. An array of match conditions to allow for multiple matching criteria. The rule is considered a match if one of the conditions is met. The conditions can be one of the following combinations (Hostname), (Hostname & Ports) EXAMPLES: Hostname - ("*.example.com"), ("xyz.example.com") Hostname and Ports - ("example.com" and "22"), ("example.com" and "22,33") etc
+      "endpointMatchers": [ # Required. Endpoint matchers associated with an application. A combination of hostname and ports as endpoint matchers is used to match the application. Match conditions for OR logic. An array of match conditions to allow for multiple matching criteria. The rule is considered a match if one of the conditions is met. The conditions should be the following combination: (Hostname & Ports) EXAMPLES: Hostname and Ports - ("*.example.com", "443"), ("example.com" and "22"), ("example.com" and "22,33") etc
         { # EndpointMatcher contains the information of the endpoint that will match the application.
           "hostname": "A String", # Required. Hostname of the application.
-          "ports": [ # Optional. Ports of the application.
+          "ports": [ # Required. Ports of the application.
             42,
           ],
         },
       ],
       "name": "A String", # Identifier. Name of the resource.
+      "schema": "A String", # Optional. Type of the external application.
       "updateTime": "A String", # Output only. Timestamp when the resource was last modified.
       "upstreams": [ # Optional. Which upstream resources to forward traffic to.
         { # Which upstream resource to forward traffic to.
@@ -344,9 +407,39 @@ 
Method Details

               "A String",
             ],
           },
+          "external": { # Endpoints to forward traffic to. # List of the external endpoints to forward traffic to.
+            "endpoints": [ # Required. List of the endpoints to forward traffic to.
+              { # Internet Gateway endpoint to forward traffic to.
+                "hostname": "A String", # Required. Hostname of the endpoint.
+                "port": 42, # Required. Port of the endpoint.
+              },
+            ],
+          },
           "network": { # Network to forward traffic to. # Network to forward traffic to.
             "name": "A String", # Required. Network name is of the format: `projects/{project}/global/networks/{network}
           },
+          "proxyProtocol": { # The configuration for the proxy. # Optional. Enables proxy protocol configuration for the upstream.
+            "allowedClientHeaders": [ # Optional. List of the allowed client header names.
+              "A String",
+            ],
+            "clientIp": True or False, # Optional. Client IP configuration. The client IP address is included if true.
+            "contextualHeaders": { # Contextual headers configuration. # Optional. Configuration for the contextual headers.
+              "deviceInfo": { # Delegated device info configuration. # Optional. Device info configuration.
+                "outputType": "A String", # Optional. The output type of the delegated device info.
+              },
+              "groupInfo": { # Delegated group info configuration. # Optional. Group info configuration.
+                "outputType": "A String", # Optional. The output type of the delegated group info.
+              },
+              "outputType": "A String", # Optional. Default output type for all enabled headers.
+              "userInfo": { # Delegated user info configuration. # Optional. User info configuration.
+                "outputType": "A String", # Optional. The output type of the delegated user info.
+              },
+            },
+            "gatewayIdentity": "A String", # Optional. Gateway identity configuration.
+            "metadataHeaders": { # Optional. Custom resource specific headers along with the values. The names should conform to RFC 9110: > Field names SHOULD constrain themselves to alphanumeric characters, "-", and ".", and SHOULD begin with a letter. Field values SHOULD contain only ASCII printable characters and tab.
+              "a_key": "A String",
+            },
+          },
         },
       ],
     },
@@ -384,15 +477,16 @@ 
Method Details

 { # The information about an application resource.
   "createTime": "A String", # Output only. Timestamp when the resource was created.
   "displayName": "A String", # Optional. An arbitrary user-provided name for the application resource. Cannot exceed 64 characters.
-  "endpointMatchers": [ # Required. Endpoint matchers associated with an application. A combination of hostname and ports as endpoint matchers is used to match the application. Match conditions for OR logic. An array of match conditions to allow for multiple matching criteria. The rule is considered a match if one of the conditions is met. The conditions can be one of the following combinations (Hostname), (Hostname & Ports) EXAMPLES: Hostname - ("*.example.com"), ("xyz.example.com") Hostname and Ports - ("example.com" and "22"), ("example.com" and "22,33") etc
+  "endpointMatchers": [ # Required. Endpoint matchers associated with an application. A combination of hostname and ports as endpoint matchers is used to match the application. Match conditions for OR logic. An array of match conditions to allow for multiple matching criteria. The rule is considered a match if one of the conditions is met. The conditions should be the following combination: (Hostname & Ports) EXAMPLES: Hostname and Ports - ("*.example.com", "443"), ("example.com" and "22"), ("example.com" and "22,33") etc
     { # EndpointMatcher contains the information of the endpoint that will match the application.
       "hostname": "A String", # Required. Hostname of the application.
-      "ports": [ # Optional. Ports of the application.
+      "ports": [ # Required. Ports of the application.
         42,
       ],
     },
   ],
   "name": "A String", # Identifier. Name of the resource.
+  "schema": "A String", # Optional. Type of the external application.
   "updateTime": "A String", # Output only. Timestamp when the resource was last modified.
   "upstreams": [ # Optional. Which upstream resources to forward traffic to.
     { # Which upstream resource to forward traffic to.
@@ -401,9 +495,39 @@ 
Method Details

           "A String",
         ],
       },
+      "external": { # Endpoints to forward traffic to. # List of the external endpoints to forward traffic to.
+        "endpoints": [ # Required. List of the endpoints to forward traffic to.
+          { # Internet Gateway endpoint to forward traffic to.
+            "hostname": "A String", # Required. Hostname of the endpoint.
+            "port": 42, # Required. Port of the endpoint.
+          },
+        ],
+      },
       "network": { # Network to forward traffic to. # Network to forward traffic to.
         "name": "A String", # Required. Network name is of the format: `projects/{project}/global/networks/{network}
       },
+      "proxyProtocol": { # The configuration for the proxy. # Optional. Enables proxy protocol configuration for the upstream.
+        "allowedClientHeaders": [ # Optional. List of the allowed client header names.
+          "A String",
+        ],
+        "clientIp": True or False, # Optional. Client IP configuration. The client IP address is included if true.
+        "contextualHeaders": { # Contextual headers configuration. # Optional. Configuration for the contextual headers.
+          "deviceInfo": { # Delegated device info configuration. # Optional. Device info configuration.
+            "outputType": "A String", # Optional. The output type of the delegated device info.
+          },
+          "groupInfo": { # Delegated group info configuration. # Optional. Group info configuration.
+            "outputType": "A String", # Optional. The output type of the delegated group info.
+          },
+          "outputType": "A String", # Optional. Default output type for all enabled headers.
+          "userInfo": { # Delegated user info configuration. # Optional. User info configuration.
+            "outputType": "A String", # Optional. The output type of the delegated user info.
+          },
+        },
+        "gatewayIdentity": "A String", # Optional. Gateway identity configuration.
+        "metadataHeaders": { # Optional. Custom resource specific headers along with the values. The names should conform to RFC 9110: > Field names SHOULD constrain themselves to alphanumeric characters, "-", and ".", and SHOULD begin with a letter. Field values SHOULD contain only ASCII printable characters and tab.
+          "a_key": "A String",
+        },
+      },
     },
   ],
 }
diff --git a/docs/dyn/beyondcorp_v1.projects.locations.securityGateways.html b/docs/dyn/beyondcorp_v1.projects.locations.securityGateways.html
index 5277123ed5e..5e51acf13bb 100644
--- a/docs/dyn/beyondcorp_v1.projects.locations.securityGateways.html
+++ b/docs/dyn/beyondcorp_v1.projects.locations.securityGateways.html
@@ -141,6 +141,35 @@ 
Method Details

     },
   },
   "name": "A String", # Identifier. Name of the resource.
+  "proxyProtocolConfig": { # The configuration for the proxy. # Optional. Shared proxy configuration for all apps.
+    "allowedClientHeaders": [ # Optional. List of the allowed client header names.
+      "A String",
+    ],
+    "clientIp": True or False, # Optional. Client IP configuration. The client IP address is included if true.
+    "contextualHeaders": { # Contextual headers configuration. # Optional. Configuration for the contextual headers.
+      "deviceInfo": { # Delegated device info configuration. # Optional. Device info configuration.
+        "outputType": "A String", # Optional. The output type of the delegated device info.
+      },
+      "groupInfo": { # Delegated group info configuration. # Optional. Group info configuration.
+        "outputType": "A String", # Optional. The output type of the delegated group info.
+      },
+      "outputType": "A String", # Optional. Default output type for all enabled headers.
+      "userInfo": { # Delegated user info configuration. # Optional. User info configuration.
+        "outputType": "A String", # Optional. The output type of the delegated user info.
+      },
+    },
+    "gatewayIdentity": "A String", # Optional. Gateway identity configuration.
+    "metadataHeaders": { # Optional. Custom resource specific headers along with the values. The names should conform to RFC 9110: > Field names SHOULD constrain themselves to alphanumeric characters, "-", and ".", and SHOULD begin with a letter. Field values SHOULD contain only ASCII printable characters and tab.
+      "a_key": "A String",
+    },
+  },
+  "serviceDiscovery": { # Settings related to the Service Discovery. # Optional. Settings related to the Service Discovery.
+    "apiGateway": { # If Service Discovery is done through API, defines its settings. # Required. External API configuration.
+      "resourceOverride": { # API operation descriptor. # Required. Enables fetching resource model updates to alter service behavior per Chrome profile.
+        "path": "A String", # Required. Contains uri path fragment where HTTP request is sent.
+      },
+    },
+  },
   "state": "A String", # Output only. The operational state of the SecurityGateway.
   "updateTime": "A String", # Output only. Timestamp when the resource was last modified.
 }
@@ -244,6 +273,35 @@ 
Method Details

     },
   },
   "name": "A String", # Identifier. Name of the resource.
+  "proxyProtocolConfig": { # The configuration for the proxy. # Optional. Shared proxy configuration for all apps.
+    "allowedClientHeaders": [ # Optional. List of the allowed client header names.
+      "A String",
+    ],
+    "clientIp": True or False, # Optional. Client IP configuration. The client IP address is included if true.
+    "contextualHeaders": { # Contextual headers configuration. # Optional. Configuration for the contextual headers.
+      "deviceInfo": { # Delegated device info configuration. # Optional. Device info configuration.
+        "outputType": "A String", # Optional. The output type of the delegated device info.
+      },
+      "groupInfo": { # Delegated group info configuration. # Optional. Group info configuration.
+        "outputType": "A String", # Optional. The output type of the delegated group info.
+      },
+      "outputType": "A String", # Optional. Default output type for all enabled headers.
+      "userInfo": { # Delegated user info configuration. # Optional. User info configuration.
+        "outputType": "A String", # Optional. The output type of the delegated user info.
+      },
+    },
+    "gatewayIdentity": "A String", # Optional. Gateway identity configuration.
+    "metadataHeaders": { # Optional. Custom resource specific headers along with the values. The names should conform to RFC 9110: > Field names SHOULD constrain themselves to alphanumeric characters, "-", and ".", and SHOULD begin with a letter. Field values SHOULD contain only ASCII printable characters and tab.
+      "a_key": "A String",
+    },
+  },
+  "serviceDiscovery": { # Settings related to the Service Discovery. # Optional. Settings related to the Service Discovery.
+    "apiGateway": { # If Service Discovery is done through API, defines its settings. # Required. External API configuration.
+      "resourceOverride": { # API operation descriptor. # Required. Enables fetching resource model updates to alter service behavior per Chrome profile.
+        "path": "A String", # Required. Contains uri path fragment where HTTP request is sent.
+      },
+    },
+  },
   "state": "A String", # Output only. The operational state of the SecurityGateway.
   "updateTime": "A String", # Output only. Timestamp when the resource was last modified.
 }
@@ -335,6 +393,35 @@

Method Details

}, }, "name": "A String", # Identifier. Name of the resource. + "proxyProtocolConfig": { # The configuration for the proxy. # Optional. Shared proxy configuration for all apps. + "allowedClientHeaders": [ # Optional. List of the allowed client header names. + "A String", + ], + "clientIp": True or False, # Optional. Client IP configuration. The client IP address is included if true. + "contextualHeaders": { # Contextual headers configuration. # Optional. Configuration for the contextual headers. + "deviceInfo": { # Delegated device info configuration. # Optional. Device info configuration. + "outputType": "A String", # Optional. The output type of the delegated device info. + }, + "groupInfo": { # Delegated group info configuration. # Optional. Group info configuration. + "outputType": "A String", # Optional. The output type of the delegated group info. + }, + "outputType": "A String", # Optional. Default output type for all enabled headers. + "userInfo": { # Delegated user info configuration. # Optional. User info configuration. + "outputType": "A String", # Optional. The output type of the delegated user info. + }, + }, + "gatewayIdentity": "A String", # Optional. Gateway identity configuration. + "metadataHeaders": { # Optional. Custom resource specific headers along with the values. The names should conform to RFC 9110: > Field names SHOULD constrain themselves to alphanumeric characters, "-", and ".", and SHOULD begin with a letter. Field values SHOULD contain only ASCII printable characters and tab. + "a_key": "A String", + }, + }, + "serviceDiscovery": { # Settings related to the Service Discovery. # Optional. Settings related to the Service Discovery. + "apiGateway": { # If Service Discovery is done through API, defines its settings. # Required. External API configuration. + "resourceOverride": { # API operation descriptor. # Required. Enables fetching resource model updates to alter service behavior per Chrome profile. + "path": "A String", # Required. Contains uri path fragment where HTTP request is sent. + }, + }, + }, "state": "A String", # Output only. The operational state of the SecurityGateway. "updateTime": "A String", # Output only. Timestamp when the resource was last modified. }, @@ -385,6 +472,35 @@

Method Details

}, }, "name": "A String", # Identifier. Name of the resource. + "proxyProtocolConfig": { # The configuration for the proxy. # Optional. Shared proxy configuration for all apps. + "allowedClientHeaders": [ # Optional. List of the allowed client header names. + "A String", + ], + "clientIp": True or False, # Optional. Client IP configuration. The client IP address is included if true. + "contextualHeaders": { # Contextual headers configuration. # Optional. Configuration for the contextual headers. + "deviceInfo": { # Delegated device info configuration. # Optional. Device info configuration. + "outputType": "A String", # Optional. The output type of the delegated device info. + }, + "groupInfo": { # Delegated group info configuration. # Optional. Group info configuration. + "outputType": "A String", # Optional. The output type of the delegated group info. + }, + "outputType": "A String", # Optional. Default output type for all enabled headers. + "userInfo": { # Delegated user info configuration. # Optional. User info configuration. + "outputType": "A String", # Optional. The output type of the delegated user info. + }, + }, + "gatewayIdentity": "A String", # Optional. Gateway identity configuration. + "metadataHeaders": { # Optional. Custom resource specific headers along with the values. The names should conform to RFC 9110: > Field names SHOULD constrain themselves to alphanumeric characters, "-", and ".", and SHOULD begin with a letter. Field values SHOULD contain only ASCII printable characters and tab. + "a_key": "A String", + }, + }, + "serviceDiscovery": { # Settings related to the Service Discovery. # Optional. Settings related to the Service Discovery. + "apiGateway": { # If Service Discovery is done through API, defines its settings. # Required. External API configuration. + "resourceOverride": { # API operation descriptor. # Required. Enables fetching resource model updates to alter service behavior per Chrome profile. + "path": "A String", # Required. Contains uri path fragment where HTTP request is sent. + }, + }, + }, "state": "A String", # Output only. The operational state of the SecurityGateway. "updateTime": "A String", # Output only. Timestamp when the resource was last modified. } diff --git a/docs/dyn/beyondcorp_v1alpha.projects.locations.securityGateways.applications.html b/docs/dyn/beyondcorp_v1alpha.projects.locations.securityGateways.applications.html index 2b5060ae65a..d3ad0af3f55 100644 --- a/docs/dyn/beyondcorp_v1alpha.projects.locations.securityGateways.applications.html +++ b/docs/dyn/beyondcorp_v1alpha.projects.locations.securityGateways.applications.html @@ -122,15 +122,16 @@

Method Details

{ # The information about an application resource. "createTime": "A String", # Output only. Timestamp when the resource was created. "displayName": "A String", # Optional. An arbitrary user-provided name for the application resource. Cannot exceed 64 characters. - "endpointMatchers": [ # Required. Endpoint matchers associated with an application. A combination of hostname and ports as endpoint matchers is used to match the application. Match conditions for OR logic. An array of match conditions to allow for multiple matching criteria. The rule is considered a match if one of the conditions is met. The conditions can be one of the following combinations (Hostname), (Hostname & Ports) EXAMPLES: Hostname - ("*.example.com"), ("xyz.example.com") Hostname and Ports - ("example.com" and "22"), ("example.com" and "22,33") etc + "endpointMatchers": [ # Required. Endpoint matchers associated with an application. A combination of hostname and ports as endpoint matchers is used to match the application. Match conditions for OR logic. An array of match conditions to allow for multiple matching criteria. The rule is considered a match if one of the conditions is met. The conditions should be the following combination: (Hostname & Ports) EXAMPLES: Hostname and Ports - ("*.example.com", "443"), ("example.com" and "22"), ("example.com" and "22,33") etc { # EndpointMatcher contains the information of the endpoint that will match the application. "hostname": "A String", # Required. Hostname of the application. - "ports": [ # Optional. Ports of the application. + "ports": [ # Required. Ports of the application. 42, ], }, ], "name": "A String", # Identifier. Name of the resource. + "schema": "A String", # Optional. Type of the external application. "updateTime": "A String", # Output only. Timestamp when the resource was last modified. "upstreams": [ # Optional. Which upstream resources to forward traffic to. { # Which upstream resource to forward traffic to. @@ -139,9 +140,39 @@

Method Details

"A String", ], }, + "external": { # Endpoints to forward traffic to. # List of the external endpoints to forward traffic to. + "endpoints": [ # Required. List of the endpoints to forward traffic to. + { # Internet Gateway endpoint to forward traffic to. + "hostname": "A String", # Required. Hostname of the endpoint. + "port": 42, # Required. Port of the endpoint. + }, + ], + }, "network": { # Network to forward traffic to. # Network to forward traffic to. "name": "A String", # Required. Network name is of the format: `projects/{project}/global/networks/{network} }, + "proxyProtocol": { # The configuration for the proxy. # Optional. Enables proxy protocol configuration for the upstream. + "allowedClientHeaders": [ # Optional. List of the allowed client header names. + "A String", + ], + "clientIp": True or False, # Optional. Client IP configuration. The client IP address is included if true. + "contextualHeaders": { # Contextual headers configuration. # Optional. Configuration for the contextual headers. + "deviceInfo": { # Delegated device info configuration. # Optional. Device info configuration. + "outputType": "A String", # Optional. The output type of the delegated device info. + }, + "groupInfo": { # Delegated group info configuration. # Optional. Group info configuration. + "outputType": "A String", # Optional. The output type of the delegated group info. + }, + "outputType": "A String", # Optional. Default output type for all enabled headers. + "userInfo": { # Delegated user info configuration. # Optional. User info configuration. + "outputType": "A String", # Optional. The output type of the delegated user info. + }, + }, + "gatewayIdentity": "A String", # Optional. Gateway identity configuration. + "metadataHeaders": { # Optional. Custom resource specific headers along with the values. The names should conform to RFC 9110: > Field names SHOULD constrain themselves to alphanumeric characters, "-", and ".", and SHOULD begin with a letter. Field values SHOULD contain only ASCII printable characters and tab. + "a_key": "A String", + }, + }, }, ], } @@ -231,15 +262,16 @@

Method Details

{ # The information about an application resource. "createTime": "A String", # Output only. Timestamp when the resource was created. "displayName": "A String", # Optional. An arbitrary user-provided name for the application resource. Cannot exceed 64 characters. - "endpointMatchers": [ # Required. Endpoint matchers associated with an application. A combination of hostname and ports as endpoint matchers is used to match the application. Match conditions for OR logic. An array of match conditions to allow for multiple matching criteria. The rule is considered a match if one of the conditions is met. The conditions can be one of the following combinations (Hostname), (Hostname & Ports) EXAMPLES: Hostname - ("*.example.com"), ("xyz.example.com") Hostname and Ports - ("example.com" and "22"), ("example.com" and "22,33") etc + "endpointMatchers": [ # Required. Endpoint matchers associated with an application. A combination of hostname and ports as endpoint matchers is used to match the application. Match conditions for OR logic. An array of match conditions to allow for multiple matching criteria. The rule is considered a match if one of the conditions is met. The conditions should be the following combination: (Hostname & Ports) EXAMPLES: Hostname and Ports - ("*.example.com", "443"), ("example.com" and "22"), ("example.com" and "22,33") etc { # EndpointMatcher contains the information of the endpoint that will match the application. "hostname": "A String", # Required. Hostname of the application. - "ports": [ # Optional. Ports of the application. + "ports": [ # Required. Ports of the application. 42, ], }, ], "name": "A String", # Identifier. Name of the resource. + "schema": "A String", # Optional. Type of the external application. "updateTime": "A String", # Output only. Timestamp when the resource was last modified. "upstreams": [ # Optional. Which upstream resources to forward traffic to. { # Which upstream resource to forward traffic to. @@ -248,9 +280,39 @@

Method Details

"A String", ], }, + "external": { # Endpoints to forward traffic to. # List of the external endpoints to forward traffic to. + "endpoints": [ # Required. List of the endpoints to forward traffic to. + { # Internet Gateway endpoint to forward traffic to. + "hostname": "A String", # Required. Hostname of the endpoint. + "port": 42, # Required. Port of the endpoint. + }, + ], + }, "network": { # Network to forward traffic to. # Network to forward traffic to. "name": "A String", # Required. Network name is of the format: `projects/{project}/global/networks/{network} }, + "proxyProtocol": { # The configuration for the proxy. # Optional. Enables proxy protocol configuration for the upstream. + "allowedClientHeaders": [ # Optional. List of the allowed client header names. + "A String", + ], + "clientIp": True or False, # Optional. Client IP configuration. The client IP address is included if true. + "contextualHeaders": { # Contextual headers configuration. # Optional. Configuration for the contextual headers. + "deviceInfo": { # Delegated device info configuration. # Optional. Device info configuration. + "outputType": "A String", # Optional. The output type of the delegated device info. + }, + "groupInfo": { # Delegated group info configuration. # Optional. Group info configuration. + "outputType": "A String", # Optional. The output type of the delegated group info. + }, + "outputType": "A String", # Optional. Default output type for all enabled headers. + "userInfo": { # Delegated user info configuration. # Optional. User info configuration. + "outputType": "A String", # Optional. The output type of the delegated user info. + }, + }, + "gatewayIdentity": "A String", # Optional. Gateway identity configuration. + "metadataHeaders": { # Optional. Custom resource specific headers along with the values. The names should conform to RFC 9110: > Field names SHOULD constrain themselves to alphanumeric characters, "-", and ".", and SHOULD begin with a letter. Field values SHOULD contain only ASCII printable characters and tab. + "a_key": "A String", + }, + }, }, ], } @@ -327,15 +389,16 @@

Method Details

{ # The information about an application resource. "createTime": "A String", # Output only. Timestamp when the resource was created. "displayName": "A String", # Optional. An arbitrary user-provided name for the application resource. Cannot exceed 64 characters. - "endpointMatchers": [ # Required. Endpoint matchers associated with an application. A combination of hostname and ports as endpoint matchers is used to match the application. Match conditions for OR logic. An array of match conditions to allow for multiple matching criteria. The rule is considered a match if one of the conditions is met. The conditions can be one of the following combinations (Hostname), (Hostname & Ports) EXAMPLES: Hostname - ("*.example.com"), ("xyz.example.com") Hostname and Ports - ("example.com" and "22"), ("example.com" and "22,33") etc + "endpointMatchers": [ # Required. Endpoint matchers associated with an application. A combination of hostname and ports as endpoint matchers is used to match the application. Match conditions for OR logic. An array of match conditions to allow for multiple matching criteria. The rule is considered a match if one of the conditions is met. The conditions should be the following combination: (Hostname & Ports) EXAMPLES: Hostname and Ports - ("*.example.com", "443"), ("example.com" and "22"), ("example.com" and "22,33") etc { # EndpointMatcher contains the information of the endpoint that will match the application. "hostname": "A String", # Required. Hostname of the application. - "ports": [ # Optional. Ports of the application. + "ports": [ # Required. Ports of the application. 42, ], }, ], "name": "A String", # Identifier. Name of the resource. + "schema": "A String", # Optional. Type of the external application. "updateTime": "A String", # Output only. Timestamp when the resource was last modified. "upstreams": [ # Optional. Which upstream resources to forward traffic to. { # Which upstream resource to forward traffic to. @@ -344,9 +407,39 @@

Method Details

"A String", ], }, + "external": { # Endpoints to forward traffic to. # List of the external endpoints to forward traffic to. + "endpoints": [ # Required. List of the endpoints to forward traffic to. + { # Internet Gateway endpoint to forward traffic to. + "hostname": "A String", # Required. Hostname of the endpoint. + "port": 42, # Required. Port of the endpoint. + }, + ], + }, "network": { # Network to forward traffic to. # Network to forward traffic to. "name": "A String", # Required. Network name is of the format: `projects/{project}/global/networks/{network} }, + "proxyProtocol": { # The configuration for the proxy. # Optional. Enables proxy protocol configuration for the upstream. + "allowedClientHeaders": [ # Optional. List of the allowed client header names. + "A String", + ], + "clientIp": True or False, # Optional. Client IP configuration. The client IP address is included if true. + "contextualHeaders": { # Contextual headers configuration. # Optional. Configuration for the contextual headers. + "deviceInfo": { # Delegated device info configuration. # Optional. Device info configuration. + "outputType": "A String", # Optional. The output type of the delegated device info. + }, + "groupInfo": { # Delegated group info configuration. # Optional. Group info configuration. + "outputType": "A String", # Optional. The output type of the delegated group info. + }, + "outputType": "A String", # Optional. Default output type for all enabled headers. + "userInfo": { # Delegated user info configuration. # Optional. User info configuration. + "outputType": "A String", # Optional. The output type of the delegated user info. + }, + }, + "gatewayIdentity": "A String", # Optional. Gateway identity configuration. + "metadataHeaders": { # Optional. Custom resource specific headers along with the values. The names should conform to RFC 9110: > Field names SHOULD constrain themselves to alphanumeric characters, "-", and ".", and SHOULD begin with a letter. Field values SHOULD contain only ASCII printable characters and tab. + "a_key": "A String", + }, + }, }, ], }, @@ -384,15 +477,16 @@

Method Details

{ # The information about an application resource. "createTime": "A String", # Output only. Timestamp when the resource was created. "displayName": "A String", # Optional. An arbitrary user-provided name for the application resource. Cannot exceed 64 characters. - "endpointMatchers": [ # Required. Endpoint matchers associated with an application. A combination of hostname and ports as endpoint matchers is used to match the application. Match conditions for OR logic. An array of match conditions to allow for multiple matching criteria. The rule is considered a match if one of the conditions is met. The conditions can be one of the following combinations (Hostname), (Hostname & Ports) EXAMPLES: Hostname - ("*.example.com"), ("xyz.example.com") Hostname and Ports - ("example.com" and "22"), ("example.com" and "22,33") etc + "endpointMatchers": [ # Required. Endpoint matchers associated with an application. A combination of hostname and ports as endpoint matchers is used to match the application. Match conditions for OR logic. An array of match conditions to allow for multiple matching criteria. The rule is considered a match if one of the conditions is met. The conditions should be the following combination: (Hostname & Ports) EXAMPLES: Hostname and Ports - ("*.example.com", "443"), ("example.com" and "22"), ("example.com" and "22,33") etc { # EndpointMatcher contains the information of the endpoint that will match the application. "hostname": "A String", # Required. Hostname of the application. - "ports": [ # Optional. Ports of the application. + "ports": [ # Required. Ports of the application. 42, ], }, ], "name": "A String", # Identifier. Name of the resource. + "schema": "A String", # Optional. Type of the external application. "updateTime": "A String", # Output only. Timestamp when the resource was last modified. "upstreams": [ # Optional. Which upstream resources to forward traffic to. { # Which upstream resource to forward traffic to. @@ -401,9 +495,39 @@

Method Details

"A String", ], }, + "external": { # Endpoints to forward traffic to. # List of the external endpoints to forward traffic to. + "endpoints": [ # Required. List of the endpoints to forward traffic to. + { # Internet Gateway endpoint to forward traffic to. + "hostname": "A String", # Required. Hostname of the endpoint. + "port": 42, # Required. Port of the endpoint. + }, + ], + }, "network": { # Network to forward traffic to. # Network to forward traffic to. "name": "A String", # Required. Network name is of the format: `projects/{project}/global/networks/{network} }, + "proxyProtocol": { # The configuration for the proxy. # Optional. Enables proxy protocol configuration for the upstream. + "allowedClientHeaders": [ # Optional. List of the allowed client header names. + "A String", + ], + "clientIp": True or False, # Optional. Client IP configuration. The client IP address is included if true. + "contextualHeaders": { # Contextual headers configuration. # Optional. Configuration for the contextual headers. + "deviceInfo": { # Delegated device info configuration. # Optional. Device info configuration. + "outputType": "A String", # Optional. The output type of the delegated device info. + }, + "groupInfo": { # Delegated group info configuration. # Optional. Group info configuration. + "outputType": "A String", # Optional. The output type of the delegated group info. + }, + "outputType": "A String", # Optional. Default output type for all enabled headers. + "userInfo": { # Delegated user info configuration. # Optional. User info configuration. + "outputType": "A String", # Optional. The output type of the delegated user info. + }, + }, + "gatewayIdentity": "A String", # Optional. Gateway identity configuration. + "metadataHeaders": { # Optional. Custom resource specific headers along with the values. The names should conform to RFC 9110: > Field names SHOULD constrain themselves to alphanumeric characters, "-", and ".", and SHOULD begin with a letter. Field values SHOULD contain only ASCII printable characters and tab. + "a_key": "A String", + }, + }, }, ], } diff --git a/docs/dyn/beyondcorp_v1alpha.projects.locations.securityGateways.html b/docs/dyn/beyondcorp_v1alpha.projects.locations.securityGateways.html index 98a55bd5e1a..f272794facd 100644 --- a/docs/dyn/beyondcorp_v1alpha.projects.locations.securityGateways.html +++ b/docs/dyn/beyondcorp_v1alpha.projects.locations.securityGateways.html @@ -141,6 +141,35 @@

Method Details

}, }, "name": "A String", # Identifier. Name of the resource. + "proxyProtocolConfig": { # The configuration for the proxy. # Optional. Shared proxy configuration for all apps. + "allowedClientHeaders": [ # Optional. List of the allowed client header names. + "A String", + ], + "clientIp": True or False, # Optional. Client IP configuration. The client IP address is included if true. + "contextualHeaders": { # Contextual headers configuration. # Optional. Configuration for the contextual headers. + "deviceInfo": { # Delegated device info configuration. # Optional. Device info configuration. + "outputType": "A String", # Optional. The output type of the delegated device info. + }, + "groupInfo": { # Delegated group info configuration. # Optional. Group info configuration. + "outputType": "A String", # Optional. The output type of the delegated group info. + }, + "outputType": "A String", # Optional. Default output type for all enabled headers. + "userInfo": { # Delegated user info configuration. # Optional. User info configuration. + "outputType": "A String", # Optional. The output type of the delegated user info. + }, + }, + "gatewayIdentity": "A String", # Optional. Gateway identity configuration. + "metadataHeaders": { # Optional. Custom resource specific headers along with the values. The names should conform to RFC 9110: > Field names SHOULD constrain themselves to alphanumeric characters, "-", and ".", and SHOULD begin with a letter. Field values SHOULD contain only ASCII printable characters and tab. + "a_key": "A String", + }, + }, + "serviceDiscovery": { # Settings related to the Service Discovery. # Optional. Settings related to the Service Discovery. + "apiGateway": { # If Service Discovery is done through API, defines its settings. # Required. External API configuration. + "resourceOverride": { # API operation descriptor. # Required. Enables fetching resource model updates to alter service behavior per Chrome profile. + "path": "A String", # Required. Contains uri path fragment where HTTP request is sent. + }, + }, + }, "state": "A String", # Output only. The operational state of the SecurityGateway. "updateTime": "A String", # Output only. Timestamp when the resource was last modified. } @@ -244,6 +273,35 @@

Method Details

}, }, "name": "A String", # Identifier. Name of the resource. + "proxyProtocolConfig": { # The configuration for the proxy. # Optional. Shared proxy configuration for all apps. + "allowedClientHeaders": [ # Optional. List of the allowed client header names. + "A String", + ], + "clientIp": True or False, # Optional. Client IP configuration. The client IP address is included if true. + "contextualHeaders": { # Contextual headers configuration. # Optional. Configuration for the contextual headers. + "deviceInfo": { # Delegated device info configuration. # Optional. Device info configuration. + "outputType": "A String", # Optional. The output type of the delegated device info. + }, + "groupInfo": { # Delegated group info configuration. # Optional. Group info configuration. + "outputType": "A String", # Optional. The output type of the delegated group info. + }, + "outputType": "A String", # Optional. Default output type for all enabled headers. + "userInfo": { # Delegated user info configuration. # Optional. User info configuration. + "outputType": "A String", # Optional. The output type of the delegated user info. + }, + }, + "gatewayIdentity": "A String", # Optional. Gateway identity configuration. + "metadataHeaders": { # Optional. Custom resource specific headers along with the values. The names should conform to RFC 9110: > Field names SHOULD constrain themselves to alphanumeric characters, "-", and ".", and SHOULD begin with a letter. Field values SHOULD contain only ASCII printable characters and tab. + "a_key": "A String", + }, + }, + "serviceDiscovery": { # Settings related to the Service Discovery. # Optional. Settings related to the Service Discovery. + "apiGateway": { # If Service Discovery is done through API, defines its settings. # Required. External API configuration. + "resourceOverride": { # API operation descriptor. # Required. Enables fetching resource model updates to alter service behavior per Chrome profile. + "path": "A String", # Required. Contains uri path fragment where HTTP request is sent. + }, + }, + }, "state": "A String", # Output only. The operational state of the SecurityGateway. "updateTime": "A String", # Output only. Timestamp when the resource was last modified. } @@ -335,6 +393,35 @@

Method Details

}, }, "name": "A String", # Identifier. Name of the resource. + "proxyProtocolConfig": { # The configuration for the proxy. # Optional. Shared proxy configuration for all apps. + "allowedClientHeaders": [ # Optional. List of the allowed client header names. + "A String", + ], + "clientIp": True or False, # Optional. Client IP configuration. The client IP address is included if true. + "contextualHeaders": { # Contextual headers configuration. # Optional. Configuration for the contextual headers. + "deviceInfo": { # Delegated device info configuration. # Optional. Device info configuration. + "outputType": "A String", # Optional. The output type of the delegated device info. + }, + "groupInfo": { # Delegated group info configuration. # Optional. Group info configuration. + "outputType": "A String", # Optional. The output type of the delegated group info. + }, + "outputType": "A String", # Optional. Default output type for all enabled headers. + "userInfo": { # Delegated user info configuration. # Optional. User info configuration. + "outputType": "A String", # Optional. The output type of the delegated user info. + }, + }, + "gatewayIdentity": "A String", # Optional. Gateway identity configuration. + "metadataHeaders": { # Optional. Custom resource specific headers along with the values. The names should conform to RFC 9110: > Field names SHOULD constrain themselves to alphanumeric characters, "-", and ".", and SHOULD begin with a letter. Field values SHOULD contain only ASCII printable characters and tab. + "a_key": "A String", + }, + }, + "serviceDiscovery": { # Settings related to the Service Discovery. # Optional. Settings related to the Service Discovery. + "apiGateway": { # If Service Discovery is done through API, defines its settings. # Required. External API configuration. + "resourceOverride": { # API operation descriptor. # Required. Enables fetching resource model updates to alter service behavior per Chrome profile. + "path": "A String", # Required. Contains uri path fragment where HTTP request is sent. + }, + }, + }, "state": "A String", # Output only. The operational state of the SecurityGateway. "updateTime": "A String", # Output only. Timestamp when the resource was last modified. }, @@ -385,6 +472,35 @@

Method Details

}, }, "name": "A String", # Identifier. Name of the resource. + "proxyProtocolConfig": { # The configuration for the proxy. # Optional. Shared proxy configuration for all apps. + "allowedClientHeaders": [ # Optional. List of the allowed client header names. + "A String", + ], + "clientIp": True or False, # Optional. Client IP configuration. The client IP address is included if true. + "contextualHeaders": { # Contextual headers configuration. # Optional. Configuration for the contextual headers. + "deviceInfo": { # Delegated device info configuration. # Optional. Device info configuration. + "outputType": "A String", # Optional. The output type of the delegated device info. + }, + "groupInfo": { # Delegated group info configuration. # Optional. Group info configuration. + "outputType": "A String", # Optional. The output type of the delegated group info. + }, + "outputType": "A String", # Optional. Default output type for all enabled headers. + "userInfo": { # Delegated user info configuration. # Optional. User info configuration. + "outputType": "A String", # Optional. The output type of the delegated user info. + }, + }, + "gatewayIdentity": "A String", # Optional. Gateway identity configuration. + "metadataHeaders": { # Optional. Custom resource specific headers along with the values. The names should conform to RFC 9110: > Field names SHOULD constrain themselves to alphanumeric characters, "-", and ".", and SHOULD begin with a letter. Field values SHOULD contain only ASCII printable characters and tab. + "a_key": "A String", + }, + }, + "serviceDiscovery": { # Settings related to the Service Discovery. # Optional. Settings related to the Service Discovery. + "apiGateway": { # If Service Discovery is done through API, defines its settings. # Required. External API configuration. + "resourceOverride": { # API operation descriptor. # Required. Enables fetching resource model updates to alter service behavior per Chrome profile. + "path": "A String", # Required. Contains uri path fragment where HTTP request is sent. + }, + }, + }, "state": "A String", # Output only. The operational state of the SecurityGateway. "updateTime": "A String", # Output only. Timestamp when the resource was last modified. } diff --git a/googleapiclient/discovery_cache/documents/beyondcorp.v1.json b/googleapiclient/discovery_cache/documents/beyondcorp.v1.json index 68668ed1e12..22442d12a6f 100644 --- a/googleapiclient/discovery_cache/documents/beyondcorp.v1.json +++ b/googleapiclient/discovery_cache/documents/beyondcorp.v1.json @@ -1899,7 +1899,7 @@ } } }, -"revision": "20250910", +"revision": "20250922", "rootUrl": "https://beyondcorp.googleapis.com/", "schemas": { "AllocatedConnection": { @@ -3145,7 +3145,7 @@ "type": "string" }, "endpointMatchers": { -"description": "Required. Endpoint matchers associated with an application. A combination of hostname and ports as endpoint matchers is used to match the application. Match conditions for OR logic. An array of match conditions to allow for multiple matching criteria. The rule is considered a match if one of the conditions is met. The conditions can be one of the following combinations (Hostname), (Hostname & Ports) EXAMPLES: Hostname - (\"*.example.com\"), (\"xyz.example.com\") Hostname and Ports - (\"example.com\" and \"22\"), (\"example.com\" and \"22,33\") etc", +"description": "Required. Endpoint matchers associated with an application. A combination of hostname and ports as endpoint matchers is used to match the application. Match conditions for OR logic. An array of match conditions to allow for multiple matching criteria. The rule is considered a match if one of the conditions is met. The conditions should be the following combination: (Hostname & Ports) EXAMPLES: Hostname and Ports - (\"*.example.com\", \"443\"), (\"example.com\" and \"22\"), (\"example.com\" and \"22,33\") etc", "items": { "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1EndpointMatcher" }, @@ -3155,6 +3155,20 @@ "description": "Identifier. Name of the resource.", "type": "string" }, +"schema": { +"description": "Optional. Type of the external application.", +"enum": [ +"SCHEMA_UNSPECIFIED", +"PROXY_GATEWAY", +"API_GATEWAY" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"Proxy which routes traffic to actual applications, like Netscaler Gateway.", +"Service Discovery API endpoint when Service Discovery is enabled in Gateway." +], +"type": "string" +}, "updateTime": { "description": "Output only. Timestamp when the resource was last modified.", "format": "google-datetime", @@ -3179,9 +3193,31 @@ "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1EgressPolicy", "description": "Optional. Routing policy information." }, +"external": { +"$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1ApplicationUpstreamExternal", +"description": "List of the external endpoints to forward traffic to." +}, "network": { "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1ApplicationUpstreamNetwork", "description": "Network to forward traffic to." +}, +"proxyProtocol": { +"$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1ProxyProtocolConfig", +"description": "Optional. Enables proxy protocol configuration for the upstream." +} +}, +"type": "object" +}, +"GoogleCloudBeyondcorpSecuritygatewaysV1ApplicationUpstreamExternal": { +"description": "Endpoints to forward traffic to.", +"id": "GoogleCloudBeyondcorpSecuritygatewaysV1ApplicationUpstreamExternal", +"properties": { +"endpoints": { +"description": "Required. List of the endpoints to forward traffic to.", +"items": { +"$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1Endpoint" +}, +"type": "array" } }, "type": "object" @@ -3197,6 +3233,110 @@ }, "type": "object" }, +"GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeaders": { +"description": "Contextual headers configuration.", +"id": "GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeaders", +"properties": { +"deviceInfo": { +"$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedDeviceInfo", +"description": "Optional. Device info configuration." +}, +"groupInfo": { +"$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedGroupInfo", +"description": "Optional. Group info configuration." +}, +"outputType": { +"description": "Optional. Default output type for all enabled headers.", +"enum": [ +"OUTPUT_TYPE_UNSPECIFIED", +"PROTOBUF", +"JSON", +"NONE" +], +"enumDescriptions": [ +"Unspecified output type.", +"Protobuf output type.", +"JSON output type.", +"Explicitly disable header output." +], +"type": "string" +}, +"userInfo": { +"$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedUserInfo", +"description": "Optional. User info configuration." +} +}, +"type": "object" +}, +"GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedDeviceInfo": { +"description": "Delegated device info configuration.", +"id": "GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedDeviceInfo", +"properties": { +"outputType": { +"description": "Optional. The output type of the delegated device info.", +"enum": [ +"OUTPUT_TYPE_UNSPECIFIED", +"PROTOBUF", +"JSON", +"NONE" +], +"enumDescriptions": [ +"Unspecified output type.", +"Protobuf output type.", +"JSON output type.", +"Explicitly disable header output." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedGroupInfo": { +"description": "Delegated group info configuration.", +"id": "GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedGroupInfo", +"properties": { +"outputType": { +"description": "Optional. The output type of the delegated group info.", +"enum": [ +"OUTPUT_TYPE_UNSPECIFIED", +"PROTOBUF", +"JSON", +"NONE" +], +"enumDescriptions": [ +"Unspecified output type.", +"Protobuf output type.", +"JSON output type.", +"Explicitly disable header output." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedUserInfo": { +"description": "Delegated user info configuration.", +"id": "GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeadersDelegatedUserInfo", +"properties": { +"outputType": { +"description": "Optional. The output type of the delegated user info.", +"enum": [ +"OUTPUT_TYPE_UNSPECIFIED", +"PROTOBUF", +"JSON", +"NONE" +], +"enumDescriptions": [ +"Unspecified output type.", +"Protobuf output type.", +"JSON output type.", +"Explicitly disable header output." +], +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudBeyondcorpSecuritygatewaysV1EgressPolicy": { "description": "Routing policy information.", "id": "GoogleCloudBeyondcorpSecuritygatewaysV1EgressPolicy", @@ -3211,6 +3351,22 @@ }, "type": "object" }, +"GoogleCloudBeyondcorpSecuritygatewaysV1Endpoint": { +"description": "Internet Gateway endpoint to forward traffic to.", +"id": "GoogleCloudBeyondcorpSecuritygatewaysV1Endpoint", +"properties": { +"hostname": { +"description": "Required. Hostname of the endpoint.", +"type": "string" +}, +"port": { +"description": "Required. Port of the endpoint.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "GoogleCloudBeyondcorpSecuritygatewaysV1EndpointMatcher": { "description": "EndpointMatcher contains the information of the endpoint that will match the application.", "id": "GoogleCloudBeyondcorpSecuritygatewaysV1EndpointMatcher", @@ -3220,7 +3376,7 @@ "type": "string" }, "ports": { -"description": "Optional. Ports of the application.", +"description": "Required. Ports of the application.", "items": { "format": "int32", "type": "integer" @@ -3306,6 +3462,47 @@ }, "type": "object" }, +"GoogleCloudBeyondcorpSecuritygatewaysV1ProxyProtocolConfig": { +"description": "The configuration for the proxy.", +"id": "GoogleCloudBeyondcorpSecuritygatewaysV1ProxyProtocolConfig", +"properties": { +"allowedClientHeaders": { +"description": "Optional. List of the allowed client header names.", +"items": { +"type": "string" +}, +"type": "array" +}, +"clientIp": { +"description": "Optional. Client IP configuration. The client IP address is included if true.", +"type": "boolean" +}, +"contextualHeaders": { +"$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1ContextualHeaders", +"description": "Optional. Configuration for the contextual headers." +}, +"gatewayIdentity": { +"description": "Optional. Gateway identity configuration.", +"enum": [ +"GATEWAY_IDENTITY_UNSPECIFIED", +"RESOURCE_NAME" +], +"enumDescriptions": [ +"Unspecified gateway identity.", +"Resource name for gateway identity, in the format: projects/{project_id}/locations/{location_id}/securityGateways/{security_gateway_id}" +], +"type": "string" +}, +"metadataHeaders": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Custom resource specific headers along with the values. The names should conform to RFC 9110: > Field names SHOULD constrain themselves to alphanumeric characters, \"-\", and \".\", and SHOULD begin with a letter. Field values SHOULD contain only ASCII printable characters and tab.", +"type": "object" +} +}, +"type": "object" +}, "GoogleCloudBeyondcorpSecuritygatewaysV1SecurityGateway": { "description": "The information about a security gateway resource.", "id": "GoogleCloudBeyondcorpSecuritygatewaysV1SecurityGateway", @@ -3344,6 +3541,14 @@ "description": "Identifier. Name of the resource.", "type": "string" }, +"proxyProtocolConfig": { +"$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1ProxyProtocolConfig", +"description": "Optional. Shared proxy configuration for all apps." +}, +"serviceDiscovery": { +"$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1ServiceDiscovery", +"description": "Optional. Settings related to the Service Discovery." +}, "state": { "description": "Output only. The operational state of the SecurityGateway.", "enum": [ @@ -3420,6 +3625,39 @@ }, "type": "object" }, +"GoogleCloudBeyondcorpSecuritygatewaysV1ServiceDiscovery": { +"description": "Settings related to the Service Discovery.", +"id": "GoogleCloudBeyondcorpSecuritygatewaysV1ServiceDiscovery", +"properties": { +"apiGateway": { +"$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1ServiceDiscoveryApiGateway", +"description": "Required. External API configuration." +} +}, +"type": "object" +}, +"GoogleCloudBeyondcorpSecuritygatewaysV1ServiceDiscoveryApiGateway": { +"description": "If Service Discovery is done through API, defines its settings.", +"id": "GoogleCloudBeyondcorpSecuritygatewaysV1ServiceDiscoveryApiGateway", +"properties": { +"resourceOverride": { +"$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1ServiceDiscoveryApiGatewayOperationDescriptor", +"description": "Required. Enables fetching resource model updates to alter service behavior per Chrome profile." +} +}, +"type": "object" +}, +"GoogleCloudBeyondcorpSecuritygatewaysV1ServiceDiscoveryApiGatewayOperationDescriptor": { +"description": "API operation descriptor.", +"id": "GoogleCloudBeyondcorpSecuritygatewaysV1ServiceDiscoveryApiGatewayOperationDescriptor", +"properties": { +"path": { +"description": "Required. Contains uri path fragment where HTTP request is sent.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata": { "description": "Represents the metadata of the long-running operation.", "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata", diff --git a/googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json b/googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json index 88fb577a28a..b7a56682e99 100644 --- a/googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json @@ -3432,7 +3432,7 @@ } } }, -"revision": "20250910", +"revision": "20250922", "rootUrl": "https://beyondcorp.googleapis.com/", "schemas": { "AllocatedConnection": { @@ -5493,7 +5493,7 @@ "type": "string" }, "endpointMatchers": { -"description": "Required. Endpoint matchers associated with an application. A combination of hostname and ports as endpoint matchers is used to match the application. Match conditions for OR logic. An array of match conditions to allow for multiple matching criteria. The rule is considered a match if one of the conditions is met. The conditions can be one of the following combinations (Hostname), (Hostname & Ports) EXAMPLES: Hostname - (\"*.example.com\"), (\"xyz.example.com\") Hostname and Ports - (\"example.com\" and \"22\"), (\"example.com\" and \"22,33\") etc", +"description": "Required. Endpoint matchers associated with an application. A combination of hostname and ports as endpoint matchers is used to match the application. Match conditions for OR logic. An array of match conditions to allow for multiple matching criteria. The rule is considered a match if one of the conditions is met. The conditions should be the following combination: (Hostname & Ports) EXAMPLES: Hostname and Ports - (\"*.example.com\", \"443\"), (\"example.com\" and \"22\"), (\"example.com\" and \"22,33\") etc", "items": { "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaEndpointMatcher" }, @@ -5503,6 +5503,20 @@ "description": "Identifier. Name of the resource.", "type": "string" }, +"schema": { +"description": "Optional. Type of the external application.", +"enum": [ +"SCHEMA_UNSPECIFIED", +"PROXY_GATEWAY", +"API_GATEWAY" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"Proxy which routes traffic to actual applications, like Netscaler Gateway.", +"Service Discovery API endpoint when Service Discovery is enabled in Gateway." +], +"type": "string" +}, "updateTime": { "description": "Output only. Timestamp when the resource was last modified.", "format": "google-datetime", @@ -5527,9 +5541,31 @@ "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaEgressPolicy", "description": "Optional. Routing policy information." }, +"external": { +"$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplicationUpstreamExternal", +"description": "List of the external endpoints to forward traffic to." +}, "network": { "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplicationUpstreamNetwork", "description": "Network to forward traffic to." +}, +"proxyProtocol": { +"$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaProxyProtocolConfig", +"description": "Optional. Enables proxy protocol configuration for the upstream." +} +}, +"type": "object" +}, +"GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplicationUpstreamExternal": { +"description": "Endpoints to forward traffic to.", +"id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplicationUpstreamExternal", +"properties": { +"endpoints": { +"description": "Required. List of the endpoints to forward traffic to.", +"items": { +"$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaEndpoint" +}, +"type": "array" } }, "type": "object" @@ -5545,6 +5581,110 @@ }, "type": "object" }, +"GoogleCloudBeyondcorpSecuritygatewaysV1alphaContextualHeaders": { +"description": "Contextual headers configuration.", +"id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaContextualHeaders", +"properties": { +"deviceInfo": { +"$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaContextualHeadersDelegatedDeviceInfo", +"description": "Optional. Device info configuration." +}, +"groupInfo": { +"$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaContextualHeadersDelegatedGroupInfo", +"description": "Optional. Group info configuration." +}, +"outputType": { +"description": "Optional. Default output type for all enabled headers.", +"enum": [ +"OUTPUT_TYPE_UNSPECIFIED", +"PROTOBUF", +"JSON", +"NONE" +], +"enumDescriptions": [ +"Unspecified output type.", +"Protobuf output type.", +"JSON output type.", +"Explicitly disable header output." +], +"type": "string" +}, +"userInfo": { +"$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaContextualHeadersDelegatedUserInfo", +"description": "Optional. User info configuration." +} +}, +"type": "object" +}, +"GoogleCloudBeyondcorpSecuritygatewaysV1alphaContextualHeadersDelegatedDeviceInfo": { +"description": "Delegated device info configuration.", +"id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaContextualHeadersDelegatedDeviceInfo", +"properties": { +"outputType": { +"description": "Optional. The output type of the delegated device info.", +"enum": [ +"OUTPUT_TYPE_UNSPECIFIED", +"PROTOBUF", +"JSON", +"NONE" +], +"enumDescriptions": [ +"Unspecified output type.", +"Protobuf output type.", +"JSON output type.", +"Explicitly disable header output." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudBeyondcorpSecuritygatewaysV1alphaContextualHeadersDelegatedGroupInfo": { +"description": "Delegated group info configuration.", +"id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaContextualHeadersDelegatedGroupInfo", +"properties": { +"outputType": { +"description": "Optional. The output type of the delegated group info.", +"enum": [ +"OUTPUT_TYPE_UNSPECIFIED", +"PROTOBUF", +"JSON", +"NONE" +], +"enumDescriptions": [ +"Unspecified output type.", +"Protobuf output type.", +"JSON output type.", +"Explicitly disable header output." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudBeyondcorpSecuritygatewaysV1alphaContextualHeadersDelegatedUserInfo": { +"description": "Delegated user info configuration.", +"id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaContextualHeadersDelegatedUserInfo", +"properties": { +"outputType": { +"description": "Optional. The output type of the delegated user info.", +"enum": [ +"OUTPUT_TYPE_UNSPECIFIED", +"PROTOBUF", +"JSON", +"NONE" +], +"enumDescriptions": [ +"Unspecified output type.", +"Protobuf output type.", +"JSON output type.", +"Explicitly disable header output." +], +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudBeyondcorpSecuritygatewaysV1alphaEgressPolicy": { "description": "Routing policy information.", "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaEgressPolicy", @@ -5559,6 +5699,22 @@ }, "type": "object" }, +"GoogleCloudBeyondcorpSecuritygatewaysV1alphaEndpoint": { +"description": "Internet Gateway endpoint to forward traffic to.", +"id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaEndpoint", +"properties": { +"hostname": { +"description": "Required. Hostname of the endpoint.", +"type": "string" +}, +"port": { +"description": "Required. Port of the endpoint.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "GoogleCloudBeyondcorpSecuritygatewaysV1alphaEndpointMatcher": { "description": "EndpointMatcher contains the information of the endpoint that will match the application.", "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaEndpointMatcher", @@ -5568,7 +5724,7 @@ "type": "string" }, "ports": { -"description": "Optional. Ports of the application.", +"description": "Required. Ports of the application.", "items": { "format": "int32", "type": "integer" @@ -5654,6 +5810,47 @@ }, "type": "object" }, +"GoogleCloudBeyondcorpSecuritygatewaysV1alphaProxyProtocolConfig": { +"description": "The configuration for the proxy.", +"id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaProxyProtocolConfig", +"properties": { +"allowedClientHeaders": { +"description": "Optional. List of the allowed client header names.", +"items": { +"type": "string" +}, +"type": "array" +}, +"clientIp": { +"description": "Optional. Client IP configuration. The client IP address is included if true.", +"type": "boolean" +}, +"contextualHeaders": { +"$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaContextualHeaders", +"description": "Optional. Configuration for the contextual headers." +}, +"gatewayIdentity": { +"description": "Optional. Gateway identity configuration.", +"enum": [ +"GATEWAY_IDENTITY_UNSPECIFIED", +"RESOURCE_NAME" +], +"enumDescriptions": [ +"Unspecified gateway identity.", +"Resource name for gateway identity, in the format: projects/{project_id}/locations/{location_id}/securityGateways/{security_gateway_id}" +], +"type": "string" +}, +"metadataHeaders": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Custom resource specific headers along with the values. The names should conform to RFC 9110: > Field names SHOULD constrain themselves to alphanumeric characters, \"-\", and \".\", and SHOULD begin with a letter. Field values SHOULD contain only ASCII printable characters and tab.", +"type": "object" +} +}, +"type": "object" +}, "GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway": { "description": "The information about a security gateway resource.", "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway", @@ -5692,6 +5889,14 @@ "description": "Identifier. Name of the resource.", "type": "string" }, +"proxyProtocolConfig": { +"$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaProxyProtocolConfig", +"description": "Optional. Shared proxy configuration for all apps." +}, +"serviceDiscovery": { +"$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaServiceDiscovery", +"description": "Optional. Settings related to the Service Discovery." +}, "state": { "description": "Output only. The operational state of the SecurityGateway.", "enum": [ @@ -5768,6 +5973,39 @@ }, "type": "object" }, +"GoogleCloudBeyondcorpSecuritygatewaysV1alphaServiceDiscovery": { +"description": "Settings related to the Service Discovery.", +"id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaServiceDiscovery", +"properties": { +"apiGateway": { +"$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaServiceDiscoveryApiGateway", +"description": "Required. External API configuration." +} +}, +"type": "object" +}, +"GoogleCloudBeyondcorpSecuritygatewaysV1alphaServiceDiscoveryApiGateway": { +"description": "If Service Discovery is done through API, defines its settings.", +"id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaServiceDiscoveryApiGateway", +"properties": { +"resourceOverride": { +"$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaServiceDiscoveryApiGatewayOperationDescriptor", +"description": "Required. Enables fetching resource model updates to alter service behavior per Chrome profile." +} +}, +"type": "object" +}, +"GoogleCloudBeyondcorpSecuritygatewaysV1alphaServiceDiscoveryApiGatewayOperationDescriptor": { +"description": "API operation descriptor.", +"id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaServiceDiscoveryApiGatewayOperationDescriptor", +"properties": { +"path": { +"description": "Required. Contains uri path fragment where HTTP request is sent.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudLocationListLocationsResponse": { "description": "The response message for Locations.ListLocations.", "id": "GoogleCloudLocationListLocationsResponse", From e597e8cd946e626e4933b0623b04fc890788421f Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 30 Sep 2025 07:09:34 +0000 Subject: [PATCH 06/42] feat(bigquery): update the api #### bigquery:v2 The following keys were added: - schemas.TableFieldSchema.properties.timestampPrecision (Total Keys: 3) --- docs/dyn/bigquery_v2.jobs.html | 17 +++++++++++++++++ docs/dyn/bigquery_v2.tables.html | 14 ++++++++++++++ .../discovery_cache/documents/bigquery.v2.json | 8 +++++++- 3 files changed, 38 insertions(+), 1 deletion(-) diff --git a/docs/dyn/bigquery_v2.jobs.html b/docs/dyn/bigquery_v2.jobs.html index 23fdaf46782..bbd20c887dc 100644 --- a/docs/dyn/bigquery_v2.jobs.html +++ b/docs/dyn/bigquery_v2.jobs.html @@ -291,6 +291,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. + "timestampPrecision": "6", # Optional. Precision (maximum number of total digits in base 10) for seconds of TIMESTAMP type. Possible values include: * 6 (Default, for TIMESTAMP type with microsecond precision) * 12 (For TIMESTAMP type with picosecond precision) "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], @@ -535,6 +536,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. + "timestampPrecision": "6", # Optional. Precision (maximum number of total digits in base 10) for seconds of TIMESTAMP type. Possible values include: * 6 (Default, for TIMESTAMP type with microsecond precision) * 12 (For TIMESTAMP type with picosecond precision) "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], @@ -1397,6 +1399,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. + "timestampPrecision": "6", # Optional. Precision (maximum number of total digits in base 10) for seconds of TIMESTAMP type. Possible values include: * 6 (Default, for TIMESTAMP type with microsecond precision) * 12 (For TIMESTAMP type with picosecond precision) "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], @@ -1792,6 +1795,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. + "timestampPrecision": "6", # Optional. Precision (maximum number of total digits in base 10) for seconds of TIMESTAMP type. Possible values include: * 6 (Default, for TIMESTAMP type with microsecond precision) * 12 (For TIMESTAMP type with picosecond precision) "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], @@ -2036,6 +2040,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. + "timestampPrecision": "6", # Optional. Precision (maximum number of total digits in base 10) for seconds of TIMESTAMP type. Possible values include: * 6 (Default, for TIMESTAMP type with microsecond precision) * 12 (For TIMESTAMP type with picosecond precision) "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], @@ -2898,6 +2903,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. + "timestampPrecision": "6", # Optional. Precision (maximum number of total digits in base 10) for seconds of TIMESTAMP type. Possible values include: * 6 (Default, for TIMESTAMP type with microsecond precision) * 12 (For TIMESTAMP type with picosecond precision) "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], @@ -3176,6 +3182,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. + "timestampPrecision": "6", # Optional. Precision (maximum number of total digits in base 10) for seconds of TIMESTAMP type. Possible values include: * 6 (Default, for TIMESTAMP type with microsecond precision) * 12 (For TIMESTAMP type with picosecond precision) "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], @@ -3380,6 +3387,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. + "timestampPrecision": "6", # Optional. Precision (maximum number of total digits in base 10) for seconds of TIMESTAMP type. Possible values include: * 6 (Default, for TIMESTAMP type with microsecond precision) * 12 (For TIMESTAMP type with picosecond precision) "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], @@ -3624,6 +3632,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. + "timestampPrecision": "6", # Optional. Precision (maximum number of total digits in base 10) for seconds of TIMESTAMP type. Possible values include: * 6 (Default, for TIMESTAMP type with microsecond precision) * 12 (For TIMESTAMP type with picosecond precision) "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], @@ -4486,6 +4495,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. + "timestampPrecision": "6", # Optional. Precision (maximum number of total digits in base 10) for seconds of TIMESTAMP type. Possible values include: * 6 (Default, for TIMESTAMP type with microsecond precision) * 12 (For TIMESTAMP type with picosecond precision) "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], @@ -4852,6 +4862,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. + "timestampPrecision": "6", # Optional. Precision (maximum number of total digits in base 10) for seconds of TIMESTAMP type. Possible values include: * 6 (Default, for TIMESTAMP type with microsecond precision) * 12 (For TIMESTAMP type with picosecond precision) "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], @@ -5096,6 +5107,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. + "timestampPrecision": "6", # Optional. Precision (maximum number of total digits in base 10) for seconds of TIMESTAMP type. Possible values include: * 6 (Default, for TIMESTAMP type with microsecond precision) * 12 (For TIMESTAMP type with picosecond precision) "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], @@ -5958,6 +5970,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. + "timestampPrecision": "6", # Optional. Precision (maximum number of total digits in base 10) for seconds of TIMESTAMP type. Possible values include: * 6 (Default, for TIMESTAMP type with microsecond precision) * 12 (For TIMESTAMP type with picosecond precision) "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], @@ -6347,6 +6360,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. + "timestampPrecision": "6", # Optional. Precision (maximum number of total digits in base 10) for seconds of TIMESTAMP type. Possible values include: * 6 (Default, for TIMESTAMP type with microsecond precision) * 12 (For TIMESTAMP type with picosecond precision) "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], @@ -6591,6 +6605,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. + "timestampPrecision": "6", # Optional. Precision (maximum number of total digits in base 10) for seconds of TIMESTAMP type. Possible values include: * 6 (Default, for TIMESTAMP type with microsecond precision) * 12 (For TIMESTAMP type with picosecond precision) "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], @@ -7455,6 +7470,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. + "timestampPrecision": "6", # Optional. Precision (maximum number of total digits in base 10) for seconds of TIMESTAMP type. Possible values include: * 6 (Default, for TIMESTAMP type with microsecond precision) * 12 (For TIMESTAMP type with picosecond precision) "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], @@ -7828,6 +7844,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. + "timestampPrecision": "6", # Optional. Precision (maximum number of total digits in base 10) for seconds of TIMESTAMP type. Possible values include: * 6 (Default, for TIMESTAMP type with microsecond precision) * 12 (For TIMESTAMP type with picosecond precision) "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], diff --git a/docs/dyn/bigquery_v2.tables.html b/docs/dyn/bigquery_v2.tables.html index ef80c0431c0..2d228ef381d 100644 --- a/docs/dyn/bigquery_v2.tables.html +++ b/docs/dyn/bigquery_v2.tables.html @@ -308,6 +308,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. + "timestampPrecision": "6", # Optional. Precision (maximum number of total digits in base 10) for seconds of TIMESTAMP type. Possible values include: * 6 (Default, for TIMESTAMP type with microsecond precision) * 12 (For TIMESTAMP type with picosecond precision) "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], @@ -461,6 +462,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. + "timestampPrecision": "6", # Optional. Precision (maximum number of total digits in base 10) for seconds of TIMESTAMP type. Possible values include: * 6 (Default, for TIMESTAMP type with microsecond precision) * 12 (For TIMESTAMP type with picosecond precision) "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], @@ -800,6 +802,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. + "timestampPrecision": "6", # Optional. Precision (maximum number of total digits in base 10) for seconds of TIMESTAMP type. Possible values include: * 6 (Default, for TIMESTAMP type with microsecond precision) * 12 (For TIMESTAMP type with picosecond precision) "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], @@ -953,6 +956,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. + "timestampPrecision": "6", # Optional. Precision (maximum number of total digits in base 10) for seconds of TIMESTAMP type. Possible values include: * 6 (Default, for TIMESTAMP type with microsecond precision) * 12 (For TIMESTAMP type with picosecond precision) "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], @@ -1233,6 +1237,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. + "timestampPrecision": "6", # Optional. Precision (maximum number of total digits in base 10) for seconds of TIMESTAMP type. Possible values include: * 6 (Default, for TIMESTAMP type with microsecond precision) * 12 (For TIMESTAMP type with picosecond precision) "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], @@ -1386,6 +1391,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. + "timestampPrecision": "6", # Optional. Precision (maximum number of total digits in base 10) for seconds of TIMESTAMP type. Possible values include: * 6 (Default, for TIMESTAMP type with microsecond precision) * 12 (For TIMESTAMP type with picosecond precision) "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], @@ -1774,6 +1780,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. + "timestampPrecision": "6", # Optional. Precision (maximum number of total digits in base 10) for seconds of TIMESTAMP type. Possible values include: * 6 (Default, for TIMESTAMP type with microsecond precision) * 12 (For TIMESTAMP type with picosecond precision) "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], @@ -1927,6 +1934,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. + "timestampPrecision": "6", # Optional. Precision (maximum number of total digits in base 10) for seconds of TIMESTAMP type. Possible values include: * 6 (Default, for TIMESTAMP type with microsecond precision) * 12 (For TIMESTAMP type with picosecond precision) "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], @@ -2208,6 +2216,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. + "timestampPrecision": "6", # Optional. Precision (maximum number of total digits in base 10) for seconds of TIMESTAMP type. Possible values include: * 6 (Default, for TIMESTAMP type with microsecond precision) * 12 (For TIMESTAMP type with picosecond precision) "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], @@ -2361,6 +2370,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. + "timestampPrecision": "6", # Optional. Precision (maximum number of total digits in base 10) for seconds of TIMESTAMP type. Possible values include: * 6 (Default, for TIMESTAMP type with microsecond precision) * 12 (For TIMESTAMP type with picosecond precision) "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], @@ -2760,6 +2770,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. + "timestampPrecision": "6", # Optional. Precision (maximum number of total digits in base 10) for seconds of TIMESTAMP type. Possible values include: * 6 (Default, for TIMESTAMP type with microsecond precision) * 12 (For TIMESTAMP type with picosecond precision) "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], @@ -2913,6 +2924,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. + "timestampPrecision": "6", # Optional. Precision (maximum number of total digits in base 10) for seconds of TIMESTAMP type. Possible values include: * 6 (Default, for TIMESTAMP type with microsecond precision) * 12 (For TIMESTAMP type with picosecond precision) "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], @@ -3194,6 +3206,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. + "timestampPrecision": "6", # Optional. Precision (maximum number of total digits in base 10) for seconds of TIMESTAMP type. Possible values include: * 6 (Default, for TIMESTAMP type with microsecond precision) * 12 (For TIMESTAMP type with picosecond precision) "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], @@ -3347,6 +3360,7 @@

Method Details

}, "roundingMode": "A String", # Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. "scale": "A String", # Optional. See documentation for precision. + "timestampPrecision": "6", # Optional. Precision (maximum number of total digits in base 10) for seconds of TIMESTAMP type. Possible values include: * 6 (Default, for TIMESTAMP type with microsecond precision) * 12 (For TIMESTAMP type with picosecond precision) "type": "A String", # Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema. }, ], diff --git a/googleapiclient/discovery_cache/documents/bigquery.v2.json b/googleapiclient/discovery_cache/documents/bigquery.v2.json index a1da6a16cf9..f6eb1ca64ec 100644 --- a/googleapiclient/discovery_cache/documents/bigquery.v2.json +++ b/googleapiclient/discovery_cache/documents/bigquery.v2.json @@ -2375,7 +2375,7 @@ } } }, -"revision": "20250912", +"revision": "20250919", "rootUrl": "https://bigquery.googleapis.com/", "schemas": { "AggregateClassificationMetrics": { @@ -9791,6 +9791,12 @@ "format": "int64", "type": "string" }, +"timestampPrecision": { +"default": "6", +"description": "Optional. Precision (maximum number of total digits in base 10) for seconds of TIMESTAMP type. Possible values include: * 6 (Default, for TIMESTAMP type with microsecond precision) * 12 (For TIMESTAMP type with picosecond precision)", +"format": "int64", +"type": "string" +}, "type": { "description": "Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE * TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE Use of RECORD/STRUCT indicates that the field contains a nested schema.", "type": "string" From 8103d979c6a49aea9a4767da6d2c21bb3cfd4316 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 30 Sep 2025 07:09:34 +0000 Subject: [PATCH 07/42] feat(certificatemanager): update the api #### certificatemanager:v1 The following keys were added: - schemas.AuthorizationAttemptInfo.properties.attemptTime (Total Keys: 3) - schemas.AuthorizationAttemptInfo.properties.troubleshooting (Total Keys: 2) - schemas.CNAME (Total Keys: 9) - schemas.IPs (Total Keys: 11) - schemas.Troubleshooting (Total Keys: 9) --- ...er_v1.projects.locations.certificates.html | 96 +++++++++++++++ .../documents/certificatemanager.v1.json | 110 +++++++++++++++++- 2 files changed, 205 insertions(+), 1 deletion(-) diff --git a/docs/dyn/certificatemanager_v1.projects.locations.certificates.html b/docs/dyn/certificatemanager_v1.projects.locations.certificates.html index fdc80628115..5a9f58f66f7 100644 --- a/docs/dyn/certificatemanager_v1.projects.locations.certificates.html +++ b/docs/dyn/certificatemanager_v1.projects.locations.certificates.html @@ -120,10 +120,34 @@

Method Details

"managed": { # Configuration and state of a Managed Certificate. Certificate Manager provisions and renews Managed Certificates automatically, for as long as it's authorized to do so. # If set, contains configuration and state of a managed certificate. "authorizationAttemptInfo": [ # Output only. Detailed state of the latest authorization attempt for each domain specified for managed certificate resource. { # State of the latest attempt to authorize a domain for certificate issuance. + "attemptTime": "A String", # Output only. The timestamp, when the authorization attempt was made. "details": "A String", # Output only. Human readable explanation for reaching the state. Provided to help address the configuration issues. Not guaranteed to be stable. For programmatic access use FailureReason enum. "domain": "A String", # Output only. Domain name of the authorization attempt. "failureReason": "A String", # Output only. Reason for failure of the authorization attempt for the domain. "state": "A String", # Output only. State of the domain for managed certificate issuance. + "troubleshooting": { # Troubleshooting information for the authorization attempt. # Output only. Troubleshooting information for the authorization attempt. This field is only populated if the authorization attempt failed. + "cname": { # CNAME troubleshooting information. # Output only. CNAME troubleshooting information. + "expectedData": "A String", # Output only. The expected value of the CNAME record for the domain, equals to `dns_resource_record.data` in the corresponding `DnsAuthorization`. + "name": "A String", # Output only. The name of the CNAME record for the domain, equals to `dns_resource_record.name` in the corresponding `DnsAuthorization`. + "resolvedData": [ # Output only. The resolved CNAME chain. Empty list if the CNAME record for `CNAME.name` is not found. Otherwise the first item is the value of the CNAME record for `CNAME.name`. If the CNAME chain is longer, the second item is the value of the CNAME record for the first item, and so on. + "A String", + ], + }, + "ips": { # IPs troubleshooting information. # Output only. IPs troubleshooting information. + "resolved": [ # Output only. The list of IP addresses resolved from the domain's A/AAAA records. Can contain both ipv4 and ipv6 addresses. + "A String", + ], + "serving": [ # Output only. The list of IP addresses, where the certificate is attached and port 443 is open. + "A String", + ], + "servingOnAltPorts": [ # Output only. The list of IP addresses, where the certificate is attached, but port 443 is not open. + "A String", + ], + }, + "issues": [ # Output only. The list of issues discovered during the authorization attempt. + "A String", + ], + }, }, ], "dnsAuthorizations": [ # Optional. Immutable. Authorizations that will be used for performing domain authorization. @@ -246,10 +270,34 @@

Method Details

"managed": { # Configuration and state of a Managed Certificate. Certificate Manager provisions and renews Managed Certificates automatically, for as long as it's authorized to do so. # If set, contains configuration and state of a managed certificate. "authorizationAttemptInfo": [ # Output only. Detailed state of the latest authorization attempt for each domain specified for managed certificate resource. { # State of the latest attempt to authorize a domain for certificate issuance. + "attemptTime": "A String", # Output only. The timestamp, when the authorization attempt was made. "details": "A String", # Output only. Human readable explanation for reaching the state. Provided to help address the configuration issues. Not guaranteed to be stable. For programmatic access use FailureReason enum. "domain": "A String", # Output only. Domain name of the authorization attempt. "failureReason": "A String", # Output only. Reason for failure of the authorization attempt for the domain. "state": "A String", # Output only. State of the domain for managed certificate issuance. + "troubleshooting": { # Troubleshooting information for the authorization attempt. # Output only. Troubleshooting information for the authorization attempt. This field is only populated if the authorization attempt failed. + "cname": { # CNAME troubleshooting information. # Output only. CNAME troubleshooting information. + "expectedData": "A String", # Output only. The expected value of the CNAME record for the domain, equals to `dns_resource_record.data` in the corresponding `DnsAuthorization`. + "name": "A String", # Output only. The name of the CNAME record for the domain, equals to `dns_resource_record.name` in the corresponding `DnsAuthorization`. + "resolvedData": [ # Output only. The resolved CNAME chain. Empty list if the CNAME record for `CNAME.name` is not found. Otherwise the first item is the value of the CNAME record for `CNAME.name`. If the CNAME chain is longer, the second item is the value of the CNAME record for the first item, and so on. + "A String", + ], + }, + "ips": { # IPs troubleshooting information. # Output only. IPs troubleshooting information. + "resolved": [ # Output only. The list of IP addresses resolved from the domain's A/AAAA records. Can contain both ipv4 and ipv6 addresses. + "A String", + ], + "serving": [ # Output only. The list of IP addresses, where the certificate is attached and port 443 is open. + "A String", + ], + "servingOnAltPorts": [ # Output only. The list of IP addresses, where the certificate is attached, but port 443 is not open. + "A String", + ], + }, + "issues": [ # Output only. The list of issues discovered during the authorization attempt. + "A String", + ], + }, }, ], "dnsAuthorizations": [ # Optional. Immutable. Authorizations that will be used for performing domain authorization. @@ -314,10 +362,34 @@

Method Details

"managed": { # Configuration and state of a Managed Certificate. Certificate Manager provisions and renews Managed Certificates automatically, for as long as it's authorized to do so. # If set, contains configuration and state of a managed certificate. "authorizationAttemptInfo": [ # Output only. Detailed state of the latest authorization attempt for each domain specified for managed certificate resource. { # State of the latest attempt to authorize a domain for certificate issuance. + "attemptTime": "A String", # Output only. The timestamp, when the authorization attempt was made. "details": "A String", # Output only. Human readable explanation for reaching the state. Provided to help address the configuration issues. Not guaranteed to be stable. For programmatic access use FailureReason enum. "domain": "A String", # Output only. Domain name of the authorization attempt. "failureReason": "A String", # Output only. Reason for failure of the authorization attempt for the domain. "state": "A String", # Output only. State of the domain for managed certificate issuance. + "troubleshooting": { # Troubleshooting information for the authorization attempt. # Output only. Troubleshooting information for the authorization attempt. This field is only populated if the authorization attempt failed. + "cname": { # CNAME troubleshooting information. # Output only. CNAME troubleshooting information. + "expectedData": "A String", # Output only. The expected value of the CNAME record for the domain, equals to `dns_resource_record.data` in the corresponding `DnsAuthorization`. + "name": "A String", # Output only. The name of the CNAME record for the domain, equals to `dns_resource_record.name` in the corresponding `DnsAuthorization`. + "resolvedData": [ # Output only. The resolved CNAME chain. Empty list if the CNAME record for `CNAME.name` is not found. Otherwise the first item is the value of the CNAME record for `CNAME.name`. If the CNAME chain is longer, the second item is the value of the CNAME record for the first item, and so on. + "A String", + ], + }, + "ips": { # IPs troubleshooting information. # Output only. IPs troubleshooting information. + "resolved": [ # Output only. The list of IP addresses resolved from the domain's A/AAAA records. Can contain both ipv4 and ipv6 addresses. + "A String", + ], + "serving": [ # Output only. The list of IP addresses, where the certificate is attached and port 443 is open. + "A String", + ], + "servingOnAltPorts": [ # Output only. The list of IP addresses, where the certificate is attached, but port 443 is not open. + "A String", + ], + }, + "issues": [ # Output only. The list of issues discovered during the authorization attempt. + "A String", + ], + }, }, ], "dnsAuthorizations": [ # Optional. Immutable. Authorizations that will be used for performing domain authorization. @@ -391,10 +463,34 @@

Method Details

"managed": { # Configuration and state of a Managed Certificate. Certificate Manager provisions and renews Managed Certificates automatically, for as long as it's authorized to do so. # If set, contains configuration and state of a managed certificate. "authorizationAttemptInfo": [ # Output only. Detailed state of the latest authorization attempt for each domain specified for managed certificate resource. { # State of the latest attempt to authorize a domain for certificate issuance. + "attemptTime": "A String", # Output only. The timestamp, when the authorization attempt was made. "details": "A String", # Output only. Human readable explanation for reaching the state. Provided to help address the configuration issues. Not guaranteed to be stable. For programmatic access use FailureReason enum. "domain": "A String", # Output only. Domain name of the authorization attempt. "failureReason": "A String", # Output only. Reason for failure of the authorization attempt for the domain. "state": "A String", # Output only. State of the domain for managed certificate issuance. + "troubleshooting": { # Troubleshooting information for the authorization attempt. # Output only. Troubleshooting information for the authorization attempt. This field is only populated if the authorization attempt failed. + "cname": { # CNAME troubleshooting information. # Output only. CNAME troubleshooting information. + "expectedData": "A String", # Output only. The expected value of the CNAME record for the domain, equals to `dns_resource_record.data` in the corresponding `DnsAuthorization`. + "name": "A String", # Output only. The name of the CNAME record for the domain, equals to `dns_resource_record.name` in the corresponding `DnsAuthorization`. + "resolvedData": [ # Output only. The resolved CNAME chain. Empty list if the CNAME record for `CNAME.name` is not found. Otherwise the first item is the value of the CNAME record for `CNAME.name`. If the CNAME chain is longer, the second item is the value of the CNAME record for the first item, and so on. + "A String", + ], + }, + "ips": { # IPs troubleshooting information. # Output only. IPs troubleshooting information. + "resolved": [ # Output only. The list of IP addresses resolved from the domain's A/AAAA records. Can contain both ipv4 and ipv6 addresses. + "A String", + ], + "serving": [ # Output only. The list of IP addresses, where the certificate is attached and port 443 is open. + "A String", + ], + "servingOnAltPorts": [ # Output only. The list of IP addresses, where the certificate is attached, but port 443 is not open. + "A String", + ], + }, + "issues": [ # Output only. The list of issues discovered during the authorization attempt. + "A String", + ], + }, }, ], "dnsAuthorizations": [ # Optional. Immutable. Authorizations that will be used for performing domain authorization. diff --git a/googleapiclient/discovery_cache/documents/certificatemanager.v1.json b/googleapiclient/discovery_cache/documents/certificatemanager.v1.json index 0033c6f5840..e3eb1fa648b 100644 --- a/googleapiclient/discovery_cache/documents/certificatemanager.v1.json +++ b/googleapiclient/discovery_cache/documents/certificatemanager.v1.json @@ -1320,7 +1320,7 @@ } } }, -"revision": "20250908", +"revision": "20250917", "rootUrl": "https://certificatemanager.googleapis.com/", "schemas": { "AllowlistedCertificate": { @@ -1338,6 +1338,12 @@ "description": "State of the latest attempt to authorize a domain for certificate issuance.", "id": "AuthorizationAttemptInfo", "properties": { +"attemptTime": { +"description": "Output only. The timestamp, when the authorization attempt was made.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, "details": { "description": "Output only. Human readable explanation for reaching the state. Provided to help address the configuration issues. Not guaranteed to be stable. For programmatic access use FailureReason enum.", "readOnly": true, @@ -1381,6 +1387,36 @@ ], "readOnly": true, "type": "string" +}, +"troubleshooting": { +"$ref": "Troubleshooting", +"description": "Output only. Troubleshooting information for the authorization attempt. This field is only populated if the authorization attempt failed.", +"readOnly": true +} +}, +"type": "object" +}, +"CNAME": { +"description": "CNAME troubleshooting information.", +"id": "CNAME", +"properties": { +"expectedData": { +"description": "Output only. The expected value of the CNAME record for the domain, equals to `dns_resource_record.data` in the corresponding `DnsAuthorization`.", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Output only. The name of the CNAME record for the domain, equals to `dns_resource_record.name` in the corresponding `DnsAuthorization`.", +"readOnly": true, +"type": "string" +}, +"resolvedData": { +"description": "Output only. The resolved CNAME chain. Empty list if the CNAME record for `CNAME.name` is not found. Otherwise the first item is the value of the CNAME record for `CNAME.name`. If the CNAME chain is longer, the second item is the value of the CNAME record for the first item, and so on.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" } }, "type": "object" @@ -1784,6 +1820,37 @@ }, "type": "object" }, +"IPs": { +"description": "IPs troubleshooting information.", +"id": "IPs", +"properties": { +"resolved": { +"description": "Output only. The list of IP addresses resolved from the domain's A/AAAA records. Can contain both ipv4 and ipv6 addresses.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"serving": { +"description": "Output only. The list of IP addresses, where the certificate is attached and port 443 is open.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"servingOnAltPorts": { +"description": "Output only. The list of IP addresses, where the certificate is attached, but port 443 is not open.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, "IntermediateCA": { "description": "Defines an intermediate CA.", "id": "IntermediateCA", @@ -2232,6 +2299,47 @@ }, "type": "object" }, +"Troubleshooting": { +"description": "Troubleshooting information for the authorization attempt.", +"id": "Troubleshooting", +"properties": { +"cname": { +"$ref": "CNAME", +"description": "Output only. CNAME troubleshooting information.", +"readOnly": true +}, +"ips": { +"$ref": "IPs", +"description": "Output only. IPs troubleshooting information.", +"readOnly": true +}, +"issues": { +"description": "Output only. The list of issues discovered during the authorization attempt.", +"items": { +"enum": [ +"ISSUE_UNSPECIFIED", +"CNAME_MISMATCH", +"RESOLVED_TO_NOT_SERVING", +"RESOLVED_TO_SERVING_ON_ALT_PORTS", +"NO_RESOLVED_IPS", +"CERTIFICATE_NOT_ATTACHED" +], +"enumDescriptions": [ +"Issue is unspecified.", +"The resolved CNAME value doesn't match the expected CNAME.", +"Domain has A/AAAA records that point to IPs, where the certificate is not attached.", +"Domain has A/AAAA records that point to IPs, where the certificate is attached, but port 443 is not open.", +"Domain doesn't have any A/AAAA records.", +"Certificate is not configured to be served from any IPs (e.g. Certificate is not attached to any load balancer)." +], +"type": "string" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, "TrustAnchor": { "description": "Defines a trust anchor.", "id": "TrustAnchor", From 76f11597add11565281c85f63976dacd150ccdf1 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 30 Sep 2025 07:09:34 +0000 Subject: [PATCH 08/42] feat(checks): update the api #### checks:v1alpha The following keys were added: - resources.accounts.resources.apps.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - schemas.ListOperationsResponse.properties.unreachable (Total Keys: 2) --- .../checks_v1alpha.accounts.apps.operations.html | 8 ++++++-- .../discovery_cache/documents/checks.v1alpha.json | 14 +++++++++++++- 2 files changed, 19 insertions(+), 3 deletions(-) diff --git a/docs/dyn/checks_v1alpha.accounts.apps.operations.html b/docs/dyn/checks_v1alpha.accounts.apps.operations.html index 2e657a91f77..dd4452e5b9e 100644 --- a/docs/dyn/checks_v1alpha.accounts.apps.operations.html +++ b/docs/dyn/checks_v1alpha.accounts.apps.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()

@@ -179,7 +179,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:
@@ -187,6 +187,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
@@ -218,6 +219,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/checks.v1alpha.json b/googleapiclient/discovery_cache/documents/checks.v1alpha.json index 2be55c06d7b..3916ef3c4c9 100644 --- a/googleapiclient/discovery_cache/documents/checks.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/checks.v1alpha.json @@ -259,6 +259,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": "v1alpha/{+name}/operations", @@ -552,7 +557,7 @@ } } }, -"revision": "20241203", +"revision": "20250925", "rootUrl": "https://checks.googleapis.com/", "schemas": { "CancelOperationRequest": { @@ -2403,6 +2408,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 48ef36e008af1c2c4e582467c380ea7ef932d9d3 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 30 Sep 2025 07:09:34 +0000 Subject: [PATCH 09/42] feat(cloudidentity): update the api #### cloudidentity:v1 The following keys were added: - resources.devices.resources.deviceUsers.methods.lookup.parameters.iosDeviceId (Total Keys: 2) - resources.devices.resources.deviceUsers.methods.lookup.parameters.partner (Total Keys: 2) --- .../cloudidentity_v1.devices.deviceUsers.html | 12 +++++++----- .../documents/cloudidentity.v1.json | 16 +++++++++++++--- 2 files changed, 20 insertions(+), 8 deletions(-) diff --git a/docs/dyn/cloudidentity_v1.devices.deviceUsers.html b/docs/dyn/cloudidentity_v1.devices.deviceUsers.html index 05fccf4c433..8e8c6c8db14 100644 --- a/docs/dyn/cloudidentity_v1.devices.deviceUsers.html +++ b/docs/dyn/cloudidentity_v1.devices.deviceUsers.html @@ -104,8 +104,8 @@

Instance Methods

list_next()

Retrieves the next page of results.

- lookup(parent, androidId=None, pageSize=None, pageToken=None, rawResourceId=None, userId=None, x__xgafv=None)

-

Looks up resource names of the DeviceUsers associated with the caller's credentials, as well as the properties provided in the request. This method must be called with end-user credentials with the scope: https://www.googleapis.com/auth/cloud-identity.devices.lookup If multiple properties are provided, only DeviceUsers having all of these properties are considered as matches - i.e. the query behaves like an AND. Different platforms require different amounts of information from the caller to ensure that the DeviceUser is uniquely identified. - iOS: No properties need to be passed, the caller's credentials are sufficient to identify the corresponding DeviceUser. - Android: Specifying the 'android_id' field is required. - Desktop: Specifying the 'raw_resource_id' field is required.

+ lookup(parent, androidId=None, iosDeviceId=None, pageSize=None, pageToken=None, partner=None, rawResourceId=None, userId=None, x__xgafv=None)

+

Looks up resource names of the DeviceUsers associated with the caller's credentials, as well as the properties provided in the request. This method must be called with end-user credentials with the scope: https://www.googleapis.com/auth/cloud-identity.devices.lookup If multiple properties are provided, only DeviceUsers having all of these properties are considered as matches - i.e. the query behaves like an AND. Different platforms require different amounts of information from the caller to ensure that the DeviceUser is uniquely identified. - iOS: Specifying the 'partner' and 'ios_device_id' fields is required. - Android: Specifying the 'android_id' field is required. - Desktop: Specifying the 'raw_resource_id' field is required.

lookup_next()

Retrieves the next page of results.

@@ -362,15 +362,17 @@

Method Details

- lookup(parent, androidId=None, pageSize=None, pageToken=None, rawResourceId=None, userId=None, x__xgafv=None) - 
Looks up resource names of the DeviceUsers associated with the caller's credentials, as well as the properties provided in the request. This method must be called with end-user credentials with the scope: https://www.googleapis.com/auth/cloud-identity.devices.lookup If multiple properties are provided, only DeviceUsers having all of these properties are considered as matches - i.e. the query behaves like an AND. Different platforms require different amounts of information from the caller to ensure that the DeviceUser is uniquely identified. - iOS: No properties need to be passed, the caller's credentials are sufficient to identify the corresponding DeviceUser. - Android: Specifying the 'android_id' field is required. - Desktop: Specifying the 'raw_resource_id' field is required.
+    lookup(parent, androidId=None, iosDeviceId=None, pageSize=None, pageToken=None, partner=None, rawResourceId=None, userId=None, x__xgafv=None)
+  
Looks up resource names of the DeviceUsers associated with the caller's credentials, as well as the properties provided in the request. This method must be called with end-user credentials with the scope: https://www.googleapis.com/auth/cloud-identity.devices.lookup If multiple properties are provided, only DeviceUsers having all of these properties are considered as matches - i.e. the query behaves like an AND. Different platforms require different amounts of information from the caller to ensure that the DeviceUser is uniquely identified. - iOS: Specifying the 'partner' and 'ios_device_id' fields is required. - Android: Specifying the 'android_id' field is required. - Desktop: Specifying the 'raw_resource_id' field is required.
 
 Args:
   parent: string, Must be set to "devices/-/deviceUsers" to search across all DeviceUser belonging to the user. (required)
   androidId: string, Android Id returned by [Settings.Secure#ANDROID_ID](https://developer.android.com/reference/android/provider/Settings.Secure.html#ANDROID_ID).
+  iosDeviceId: string, Optional. The partner-specified device identifier assigned to the iOS device that initiated the Lookup API call. This string must match the value of the iosDeviceId key in the app config dictionary provided to Google Workspace apps.
   pageSize: integer, The maximum number of DeviceUsers to return. If unspecified, at most 20 DeviceUsers will be returned. The maximum value is 20; values above 20 will be coerced to 20.
   pageToken: string, A page token, received from a previous `LookupDeviceUsers` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `LookupDeviceUsers` must match the call that provided the page token.
-  rawResourceId: string, Raw Resource Id used by Google Endpoint Verification. If the user is enrolled into Google Endpoint Verification, this id will be saved as the 'device_resource_id' field in the following platform dependent files. * macOS: ~/.secureConnect/context_aware_config.json * Windows: %USERPROFILE%\AppData\Local\Google\Endpoint Verification\accounts.json * Linux: ~/.secureConnect/context_aware_config.json
+  partner: string, Optional. The partner ID of the calling iOS app. This string must match the value of the partner key within the app configuration dictionary provided to Google Workspace apps.
+  rawResourceId: string, Raw Resource Id used by Google Endpoint Verification. If the user is enrolled into Google Endpoint Verification, this id will be saved as the 'device_resource_id' field in the following platform dependent files. Mac: ~/.secureConnect/context_aware_config.json Windows: C:\Users\%USERPROFILE%\.secureConnect\context_aware_config.json Linux: ~/.secureConnect/context_aware_config.json
   userId: string, The user whose DeviceUser's resource name will be fetched. Must be set to 'me' to fetch the DeviceUser's resource name for the calling user.
   x__xgafv: string, V1 error format.
     Allowed values
diff --git a/googleapiclient/discovery_cache/documents/cloudidentity.v1.json b/googleapiclient/discovery_cache/documents/cloudidentity.v1.json
index 9a51b3241cc..1b0fb08feb3 100644
--- a/googleapiclient/discovery_cache/documents/cloudidentity.v1.json
+++ b/googleapiclient/discovery_cache/documents/cloudidentity.v1.json
@@ -680,7 +680,7 @@
 ]
 },
 "lookup": {
-"description": "Looks up resource names of the DeviceUsers associated with the caller's credentials, as well as the properties provided in the request. This method must be called with end-user credentials with the scope: https://www.googleapis.com/auth/cloud-identity.devices.lookup If multiple properties are provided, only DeviceUsers having all of these properties are considered as matches - i.e. the query behaves like an AND. Different platforms require different amounts of information from the caller to ensure that the DeviceUser is uniquely identified. - iOS: No properties need to be passed, the caller's credentials are sufficient to identify the corresponding DeviceUser. - Android: Specifying the 'android_id' field is required. - Desktop: Specifying the 'raw_resource_id' field is required.",
+"description": "Looks up resource names of the DeviceUsers associated with the caller's credentials, as well as the properties provided in the request. This method must be called with end-user credentials with the scope: https://www.googleapis.com/auth/cloud-identity.devices.lookup If multiple properties are provided, only DeviceUsers having all of these properties are considered as matches - i.e. the query behaves like an AND. Different platforms require different amounts of information from the caller to ensure that the DeviceUser is uniquely identified. - iOS: Specifying the 'partner' and 'ios_device_id' fields is required. - Android: Specifying the 'android_id' field is required. - Desktop: Specifying the 'raw_resource_id' field is required.",
 "flatPath": "v1/devices/{devicesId}/deviceUsers:lookup",
 "httpMethod": "GET",
 "id": "cloudidentity.devices.deviceUsers.lookup",
@@ -693,6 +693,11 @@
 "location": "query",
 "type": "string"
 },
+"iosDeviceId": {
+"description": "Optional. The partner-specified device identifier assigned to the iOS device that initiated the Lookup API call. This string must match the value of the iosDeviceId key in the app config dictionary provided to Google Workspace apps.",
+"location": "query",
+"type": "string"
+},
 "pageSize": {
 "description": "The maximum number of DeviceUsers to return. If unspecified, at most 20 DeviceUsers will be returned. The maximum value is 20; values above 20 will be coerced to 20.",
 "format": "int32",
@@ -711,8 +716,13 @@
 "required": true,
 "type": "string"
 },
+"partner": {
+"description": "Optional. The partner ID of the calling iOS app. This string must match the value of the partner key within the app configuration dictionary provided to Google Workspace apps.",
+"location": "query",
+"type": "string"
+},
 "rawResourceId": {
-"description": "Raw Resource Id used by Google Endpoint Verification. If the user is enrolled into Google Endpoint Verification, this id will be saved as the 'device_resource_id' field in the following platform dependent files. * macOS: ~/.secureConnect/context_aware_config.json * Windows: %USERPROFILE%\\AppData\\Local\\Google\\Endpoint Verification\\accounts.json * Linux: ~/.secureConnect/context_aware_config.json",
+"description": "Raw Resource Id used by Google Endpoint Verification. If the user is enrolled into Google Endpoint Verification, this id will be saved as the 'device_resource_id' field in the following platform dependent files. Mac: ~/.secureConnect/context_aware_config.json Windows: C:\\Users\\%USERPROFILE%\\.secureConnect\\context_aware_config.json Linux: ~/.secureConnect/context_aware_config.json",
 "location": "query",
 "type": "string"
 },
@@ -2230,7 +2240,7 @@
 }
 }
 },
-"revision": "20250805",
+"revision": "20250923",
 "rootUrl": "https://cloudidentity.googleapis.com/",
 "schemas": {
 "AddIdpCredentialOperationMetadata": {

From e7c1a304146103814287280dc184e2fa36ff4de3 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 30 Sep 2025 07:09:34 +0000
Subject: [PATCH 10/42] feat(cloudscheduler): update the api

#### cloudscheduler:v1

The following keys were deleted:
- resources.operations.methods.cancel (Total Keys: 11)
- resources.operations.methods.delete (Total Keys: 10)
- resources.operations.methods.get (Total Keys: 10)
- resources.operations.methods.list (Total Keys: 17)

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: 18)
---
 docs/dyn/cloudscheduler_v1.html               |   5 -
 .../cloudscheduler_v1.projects.locations.html |   7 +-
 ...uler_v1.projects.locations.operations.html | 235 +++++++++++++++++
 ...dscheduler_v1beta1.projects.locations.html |   2 +-
 .../documents/cloudscheduler.v1.json          | 238 +++++++++---------
 .../documents/cloudscheduler.v1beta1.json     |   4 +-
 6 files changed, 369 insertions(+), 122 deletions(-)
 create mode 100644 docs/dyn/cloudscheduler_v1.projects.locations.operations.html

diff --git a/docs/dyn/cloudscheduler_v1.html b/docs/dyn/cloudscheduler_v1.html
index 2348710a78a..cebf73c9ff7 100644
--- a/docs/dyn/cloudscheduler_v1.html
+++ b/docs/dyn/cloudscheduler_v1.html
@@ -74,11 +74,6 @@
 
 
Cloud Scheduler API

 
Instance Methods

-

-  operations()
-

-
Returns the operations Resource.

-
 

   projects()
 

diff --git a/docs/dyn/cloudscheduler_v1.projects.locations.html b/docs/dyn/cloudscheduler_v1.projects.locations.html
index dda2239021a..fb02a9b98eb 100644
--- a/docs/dyn/cloudscheduler_v1.projects.locations.html
+++ b/docs/dyn/cloudscheduler_v1.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. 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/cloudscheduler_v1.projects.locations.operations.html b/docs/dyn/cloudscheduler_v1.projects.locations.operations.html
new file mode 100644
index 00000000000..08d36ca6b56
--- /dev/null
+++ b/docs/dyn/cloudscheduler_v1.projects.locations.operations.html
@@ -0,0 +1,235 @@
+
+
+
+
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, 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, 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.
+  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.
+      },
+    },
+  ],
+}

+

+
+

+    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/cloudscheduler_v1beta1.projects.locations.html b/docs/dyn/cloudscheduler_v1beta1.projects.locations.html
index df762352ca7..d325b844e28 100644
--- a/docs/dyn/cloudscheduler_v1beta1.projects.locations.html
+++ b/docs/dyn/cloudscheduler_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. 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/googleapiclient/discovery_cache/documents/cloudscheduler.v1.json b/googleapiclient/discovery_cache/documents/cloudscheduler.v1.json
index f83ffc5e94b..524bbfdefd5 100644
--- a/googleapiclient/discovery_cache/documents/cloudscheduler.v1.json
+++ b/googleapiclient/discovery_cache/documents/cloudscheduler.v1.json
@@ -105,117 +105,6 @@
 },
 "protocol": "rest",
 "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/operations/{operationsId}:cancel",
-"httpMethod": "POST",
-"id": "cloudscheduler.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",
-"request": {
-"$ref": "CancelOperationRequest"
-},
-"response": {
-"$ref": "Empty"
-}
-},
-"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": "cloudscheduler.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": "Empty"
-}
-},
-"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": "cloudscheduler.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": "Operation"
-}
-},
-"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": "cloudscheduler.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": "^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"
-}
-},
-"path": "v1/{+name}",
-"response": {
-"$ref": "ListOperationsResponse"
-}
-}
-}
-},
 "projects": {
 "resources": {
 "locations": {
@@ -255,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"
@@ -529,13 +418,136 @@
 ]
 }
 }
+},
+"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",
+"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": "v1/{+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": "v1/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": "v1/{+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": "v1/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": "v1/{+name}",
+"response": {
+"$ref": "Operation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/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"
+}
+},
+"path": "v1/{+name}/operations",
+"response": {
+"$ref": "ListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
 }
 }
 }
 }
 }
 },
-"revision": "20250530",
+"revision": "20250917",
 "rootUrl": "https://cloudscheduler.googleapis.com/",
 "schemas": {
 "AppEngineHttpTarget": {
diff --git a/googleapiclient/discovery_cache/documents/cloudscheduler.v1beta1.json b/googleapiclient/discovery_cache/documents/cloudscheduler.v1beta1.json
index db932eb486b..be91f4d7816 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. 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"
@@ -439,7 +439,7 @@
 }
 }
 },
-"revision": "20250530",
+"revision": "20250917",
 "rootUrl": "https://cloudscheduler.googleapis.com/",
 "schemas": {
 "AppEngineHttpTarget": {

From dad1b28292640a4910be2dfccfa7393143b067b5 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 30 Sep 2025 07:09:35 +0000
Subject: [PATCH 11/42] feat(compute): update the api

#### compute:alpha

The following keys were deleted:
- resources.disks.methods.updateKmskey (Total Keys: 20)
- schemas.ForwardingRule.properties.trafficDisabled.type (Total Keys: 1)

The following keys were added:
- resources.disks.methods.updateKmsKey (Total Keys: 20)
- schemas.Address.properties.ipCollection.type (Total Keys: 1)
- schemas.NetworkInterface.properties.enableVpcScopedDns.type (Total Keys: 1)
- schemas.NetworkPolicyTrafficClassificationRuleAction.properties.dscpMode.type (Total Keys: 1)
- schemas.NetworkPolicyTrafficClassificationRuleAction.properties.dscpValue (Total Keys: 2)
- schemas.NetworkPolicyTrafficClassificationRuleAction.properties.trafficClass.type (Total Keys: 1)
- schemas.PublicDelegatedPrefix.properties.enableEnhancedIpv4Allocation.type (Total Keys: 1)
- schemas.PublicDelegatedPrefixPublicDelegatedSubPrefix.properties.enableEnhancedIpv4Allocation.type (Total Keys: 1)

#### compute:beta

The following keys were added:
- resources.regionHealthSources.methods.aggregatedList (Total Keys: 29)
- resources.regionHealthSources.methods.delete (Total Keys: 21)
- resources.regionHealthSources.methods.get (Total Keys: 19)
- resources.regionHealthSources.methods.insert (Total Keys: 18)
- resources.regionHealthSources.methods.list (Total Keys: 28)
- resources.regionHealthSources.methods.patch (Total Keys: 21)
- resources.regionHealthSources.methods.testIamPermissions (Total Keys: 20)
- resources.regionNetworkPolicies.methods.addAssociation (Total Keys: 22)
- resources.regionNetworkPolicies.methods.addTrafficClassificationRule (Total Keys: 22)
- resources.regionNetworkPolicies.methods.aggregatedList (Total Keys: 29)
- resources.regionNetworkPolicies.methods.delete (Total Keys: 21)
- resources.regionNetworkPolicies.methods.get (Total Keys: 62)
- resources.regionNetworkPolicies.methods.insert (Total Keys: 18)
- resources.regionNetworkPolicies.methods.list (Total Keys: 28)
- resources.regionNetworkPolicies.methods.patch (Total Keys: 47)
- resources.regionNetworkPolicies.methods.removeAssociation (Total Keys: 23)
- resources.regionNetworkPolicies.methods.removeTrafficClassificationRule (Total Keys: 24)
- resources.reservationSubBlocks.methods.reportFaulty (Total Keys: 22)
- schemas.Address.properties.ipCollection.type (Total Keys: 1)
- schemas.HealthSource (Total Keys: 61)
- schemas.Image.properties.params.$ref (Total Keys: 1)
- schemas.ImageParams (Total Keys: 4)
- schemas.Interconnect.properties.subzone.type (Total Keys: 1)
- schemas.NetworkPoliciesScopedList (Total Keys: 11)
- schemas.NetworkPolicy (Total Keys: 88)
- schemas.PublicDelegatedPrefix.properties.enableEnhancedIpv4Allocation.type (Total Keys: 1)
- schemas.PublicDelegatedPrefixPublicDelegatedSubPrefix.properties.enableEnhancedIpv4Allocation.type (Total Keys: 1)
- schemas.ReservationSubBlocksReportFaultyRequest (Total Keys: 9)
- schemas.Snapshot.properties.params.$ref (Total Keys: 1)
- schemas.SnapshotParams (Total Keys: 4)

#### compute:v1

The following keys were added:
- resources.backendServices.methods.getEffectiveSecurityPolicies (Total Keys: 14)
- resources.organizationSecurityPolicies.methods.addAssociation (Total Keys: 16)
- resources.organizationSecurityPolicies.methods.addRule (Total Keys: 14)
- resources.organizationSecurityPolicies.methods.copyRules (Total Keys: 15)
- resources.organizationSecurityPolicies.methods.delete (Total Keys: 13)
- resources.organizationSecurityPolicies.methods.get (Total Keys: 38)
- resources.organizationSecurityPolicies.methods.insert (Total Keys: 11)
- resources.organizationSecurityPolicies.methods.list (Total Keys: 50)
- resources.organizationSecurityPolicies.methods.move (Total Keys: 15)
- resources.organizationSecurityPolicies.methods.patch (Total Keys: 31)
- resources.organizationSecurityPolicies.methods.removeAssociation (Total Keys: 15)
- resources.organizationSecurityPolicies.methods.removeRule (Total Keys: 16)
- resources.previewFeatures.methods.get (Total Keys: 15)
- resources.previewFeatures.methods.list (Total Keys: 24)
- resources.previewFeatures.methods.update (Total Keys: 18)
- resources.reservationSubBlocks.methods.reportFaulty (Total Keys: 22)
- schemas.Date (Total Keys: 8)
- schemas.Image.properties.params.$ref (Total Keys: 1)
- schemas.ImageParams (Total Keys: 4)
- schemas.Interconnect.properties.subzone.type (Total Keys: 1)
- schemas.OrganizationSecurityPoliciesListAssociationsResponse (Total Keys: 6)
- schemas.PreviewFeature (Total Keys: 44)
- schemas.ReservationSubBlocksReportFaultyRequest (Total Keys: 9)
- schemas.SecurityPolicy.properties.associations (Total Keys: 2)
- schemas.SecurityPolicy.properties.shortName (Total Keys: 2)
- schemas.SecurityPolicyAssociation (Total Keys: 12)
- schemas.Snapshot.properties.params.$ref (Total Keys: 1)
- schemas.SnapshotParams (Total Keys: 4)
---
 docs/dyn/compute_alpha.addresses.html         |    4 +
 docs/dyn/compute_alpha.disks.html             |    6 +-
 docs/dyn/compute_alpha.forwardingRules.html   |    5 -
 docs/dyn/compute_alpha.globalAddresses.html   |    3 +
 .../compute_alpha.globalForwardingRules.html  |    4 -
 ...e_alpha.globalPublicDelegatedPrefixes.html |    8 +
 docs/dyn/compute_alpha.instanceTemplates.html |    4 +
 docs/dyn/compute_alpha.instances.html         |    8 +
 docs/dyn/compute_alpha.machineImages.html     |    6 +
 ...compute_alpha.publicDelegatedPrefixes.html |   10 +
 docs/dyn/compute_alpha.regionDisks.html       |    2 +-
 ...compute_alpha.regionInstanceTemplates.html |    3 +
 docs/dyn/compute_alpha.regionInstances.html   |    1 +
 .../compute_alpha.regionNetworkPolicies.html  |   30 +-
 docs/dyn/compute_alpha.regionSnapshots.html   |    6 +-
 docs/dyn/compute_alpha.routers.html           |    4 +
 docs/dyn/compute_alpha.snapshots.html         |    8 +-
 .../compute_alpha.zoneQueuedResources.html    |    4 +
 docs/dyn/compute_beta.addresses.html          |    4 +
 docs/dyn/compute_beta.disks.html              |    7 +-
 docs/dyn/compute_beta.globalAddresses.html    |    3 +
 ...te_beta.globalPublicDelegatedPrefixes.html |    8 +
 docs/dyn/compute_beta.html                    |   10 +
 docs/dyn/compute_beta.imageFamilyViews.html   |    5 +
 docs/dyn/compute_beta.images.html             |   25 +
 docs/dyn/compute_beta.interconnects.html      |    4 +
 .../compute_beta.publicDelegatedPrefixes.html |   10 +
 docs/dyn/compute_beta.regionDisks.html        |    7 +-
 .../dyn/compute_beta.regionHealthSources.html |  748 ++
 .../compute_beta.regionNetworkPolicies.html   | 1749 +++
 docs/dyn/compute_beta.regionSnapshots.html    |   21 +-
 .../compute_beta.reservationSubBlocks.html    |  143 +
 docs/dyn/compute_beta.snapshots.html          |   28 +-
 docs/dyn/compute_v1.backendServices.html      |   17 +
 docs/dyn/compute_v1.disks.html                |    7 +-
 docs/dyn/compute_v1.html                      |   10 +
 docs/dyn/compute_v1.imageFamilyViews.html     |    5 +
 docs/dyn/compute_v1.images.html               |   25 +
 docs/dyn/compute_v1.interconnects.html        |    4 +
 ...mpute_v1.organizationSecurityPolicies.html | 2867 +++++
 docs/dyn/compute_v1.previewFeatures.html      |  380 +
 docs/dyn/compute_v1.regionDisks.html          |    7 +-
 .../compute_v1.regionSecurityPolicies.html    |   64 +
 docs/dyn/compute_v1.reservationSubBlocks.html |  143 +
 docs/dyn/compute_v1.securityPolicies.html     |   80 +
 docs/dyn/compute_v1.snapshots.html            |   21 +-
 .../documents/compute.alpha.json              |   73 +-
 .../documents/compute.beta.json               | 9524 +++++++++++------
 .../discovery_cache/documents/compute.v1.json | 2009 +++-
 49 files changed, 14170 insertions(+), 3954 deletions(-)
 create mode 100644 docs/dyn/compute_beta.regionHealthSources.html
 create mode 100644 docs/dyn/compute_beta.regionNetworkPolicies.html
 create mode 100644 docs/dyn/compute_v1.organizationSecurityPolicies.html
 create mode 100644 docs/dyn/compute_v1.previewFeatures.html

diff --git a/docs/dyn/compute_alpha.addresses.html b/docs/dyn/compute_alpha.addresses.html
index 5f9c7115928..b85660b2cac 100644
--- a/docs/dyn/compute_alpha.addresses.html
+++ b/docs/dyn/compute_alpha.addresses.html
@@ -140,6 +140,7 @@ 
Method Details

           "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
           "description": "A String", # An optional description of this resource. Provide this field when you create the resource.
           "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+          "ipCollection": "A String", # Reference to the source of external IPv4 addresses, like a PublicDelegatedPrefix (PDP) for BYOIP. The PDP must support enhanced IPv4 allocations. Use one of the following formats to specify a PDP when reserving an external IPv4 address using BYOIP. - Full resource URL, as in https://www.googleapis.com/compute/v1/projects/projectId/regions/region /publicDelegatedPrefixes/pdp-name - Partial URL, as in - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name - regions/region/publicDelegatedPrefixes/pdp-name
           "ipVersion": "A String", # The IP version that will be used by this address. Valid options are IPV4 or IPV6.
           "ipv6EndpointType": "A String", # The endpoint type of this address, which should be VM or NETLB. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation.
           "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
@@ -360,6 +361,7 @@ 
Method Details

   "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
   "description": "A String", # An optional description of this resource. Provide this field when you create the resource.
   "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+  "ipCollection": "A String", # Reference to the source of external IPv4 addresses, like a PublicDelegatedPrefix (PDP) for BYOIP. The PDP must support enhanced IPv4 allocations. Use one of the following formats to specify a PDP when reserving an external IPv4 address using BYOIP. - Full resource URL, as in https://www.googleapis.com/compute/v1/projects/projectId/regions/region /publicDelegatedPrefixes/pdp-name - Partial URL, as in - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name - regions/region/publicDelegatedPrefixes/pdp-name
   "ipVersion": "A String", # The IP version that will be used by this address. Valid options are IPV4 or IPV6.
   "ipv6EndpointType": "A String", # The endpoint type of this address, which should be VM or NETLB. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation.
   "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
@@ -399,6 +401,7 @@ 
Method Details

   "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
   "description": "A String", # An optional description of this resource. Provide this field when you create the resource.
   "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+  "ipCollection": "A String", # Reference to the source of external IPv4 addresses, like a PublicDelegatedPrefix (PDP) for BYOIP. The PDP must support enhanced IPv4 allocations. Use one of the following formats to specify a PDP when reserving an external IPv4 address using BYOIP. - Full resource URL, as in https://www.googleapis.com/compute/v1/projects/projectId/regions/region /publicDelegatedPrefixes/pdp-name - Partial URL, as in - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name - regions/region/publicDelegatedPrefixes/pdp-name
   "ipVersion": "A String", # The IP version that will be used by this address. Valid options are IPV4 or IPV6.
   "ipv6EndpointType": "A String", # The endpoint type of this address, which should be VM or NETLB. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation.
   "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
@@ -568,6 +571,7 @@ 
Method Details

       "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
       "description": "A String", # An optional description of this resource. Provide this field when you create the resource.
       "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+      "ipCollection": "A String", # Reference to the source of external IPv4 addresses, like a PublicDelegatedPrefix (PDP) for BYOIP. The PDP must support enhanced IPv4 allocations. Use one of the following formats to specify a PDP when reserving an external IPv4 address using BYOIP. - Full resource URL, as in https://www.googleapis.com/compute/v1/projects/projectId/regions/region /publicDelegatedPrefixes/pdp-name - Partial URL, as in - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name - regions/region/publicDelegatedPrefixes/pdp-name
       "ipVersion": "A String", # The IP version that will be used by this address. Valid options are IPV4 or IPV6.
       "ipv6EndpointType": "A String", # The endpoint type of this address, which should be VM or NETLB. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation.
       "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
diff --git a/docs/dyn/compute_alpha.disks.html b/docs/dyn/compute_alpha.disks.html
index fd8f0270272..60701e689f0 100644
--- a/docs/dyn/compute_alpha.disks.html
+++ b/docs/dyn/compute_alpha.disks.html
@@ -144,7 +144,7 @@ 
Instance Methods

   update(project, zone, disk, body=None, paths=None, requestId=None, updateMask=None, x__xgafv=None)

 
Updates the specified disk with the data included in the request. The update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: user_license.

 

-  updateKmskey(project, zone, disk, requestId=None, x__xgafv=None)

+  updateKmsKey(project, zone, disk, requestId=None, x__xgafv=None)

 
Rotates the customer-managed encryption key to the latest version for the specified persistent disk.

 

   waitForReplicationCatchUp(project, zone, disk, body=None, requestId=None, x__xgafv=None)

@@ -788,7 +788,7 @@ 
Method Details

   body: object, The request body.
     The object takes the form of:
 
-{ # Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. LINT.IfChange
+{ # Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots.
   "architecture": "A String", # [Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64.
   "autoCreated": True or False, # [Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk.
   "chainName": "A String", # Creates the new snapshot in the snapshot chain labeled with the specified name. The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value.
@@ -2998,7 +2998,7 @@ 
Method Details
- updateKmskey(project, zone, disk, requestId=None, x__xgafv=None) + updateKmsKey(project, zone, disk, requestId=None, x__xgafv=None) 
Rotates the customer-managed encryption key to the latest version for the specified persistent disk.
 
 Args:
diff --git a/docs/dyn/compute_alpha.forwardingRules.html b/docs/dyn/compute_alpha.forwardingRules.html
index c829dbd2f93..6729bcfa003 100644
--- a/docs/dyn/compute_alpha.forwardingRules.html
+++ b/docs/dyn/compute_alpha.forwardingRules.html
@@ -199,7 +199,6 @@ 
Method Details

           ],
           "subnetwork": "A String", # This field identifies the subnetwork that the load balanced IP should belong to for this forwarding rule, used with internal load balancers and external passthrough Network Load Balancers with IPv6. If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6.
           "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. - For load balancers, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. The target is not mutable once set as a service attachment.
-          "trafficDisabled": True or False, # [PSC for VPC-hosted services only] Determines if clients are allowed to access the producer service via this PSC endpoint.
         },
       ],
       "warning": { # Informational warning which replaces the list of forwarding rules when the list is empty.
@@ -456,7 +455,6 @@ 
Method Details

   ],
   "subnetwork": "A String", # This field identifies the subnetwork that the load balanced IP should belong to for this forwarding rule, used with internal load balancers and external passthrough Network Load Balancers with IPv6. If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6.
   "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. - For load balancers, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. The target is not mutable once set as a service attachment.
-  "trafficDisabled": True or False, # [PSC for VPC-hosted services only] Determines if clients are allowed to access the producer service via this PSC endpoint.
 }
@@ -532,7 +530,6 @@

Method Details

], "subnetwork": "A String", # This field identifies the subnetwork that the load balanced IP should belong to for this forwarding rule, used with internal load balancers and external passthrough Network Load Balancers with IPv6. If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6. "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. - For load balancers, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. The target is not mutable once set as a service attachment. - "trafficDisabled": True or False, # [PSC for VPC-hosted services only] Determines if clients are allowed to access the producer service via this PSC endpoint. } 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). @@ -738,7 +735,6 @@

Method Details

], "subnetwork": "A String", # This field identifies the subnetwork that the load balanced IP should belong to for this forwarding rule, used with internal load balancers and external passthrough Network Load Balancers with IPv6. If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6. "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. - For load balancers, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. The target is not mutable once set as a service attachment. - "trafficDisabled": True or False, # [PSC for VPC-hosted services only] Determines if clients are allowed to access the producer service via this PSC endpoint. }, ], "kind": "compute#forwardingRuleList", # Type of resource. @@ -844,7 +840,6 @@

Method Details

], "subnetwork": "A String", # This field identifies the subnetwork that the load balanced IP should belong to for this forwarding rule, used with internal load balancers and external passthrough Network Load Balancers with IPv6. If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6. "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. - For load balancers, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. The target is not mutable once set as a service attachment. - "trafficDisabled": True or False, # [PSC for VPC-hosted services only] Determines if clients are allowed to access the producer service via this PSC endpoint. } 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). diff --git a/docs/dyn/compute_alpha.globalAddresses.html b/docs/dyn/compute_alpha.globalAddresses.html index c5189591120..7235aab4871 100644 --- a/docs/dyn/compute_alpha.globalAddresses.html +++ b/docs/dyn/compute_alpha.globalAddresses.html @@ -256,6 +256,7 @@

Method Details

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "description": "A String", # An optional description of this resource. Provide this field when you create the resource. "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "ipCollection": "A String", # Reference to the source of external IPv4 addresses, like a PublicDelegatedPrefix (PDP) for BYOIP. The PDP must support enhanced IPv4 allocations. Use one of the following formats to specify a PDP when reserving an external IPv4 address using BYOIP. - Full resource URL, as in https://www.googleapis.com/compute/v1/projects/projectId/regions/region /publicDelegatedPrefixes/pdp-name - Partial URL, as in - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name - regions/region/publicDelegatedPrefixes/pdp-name "ipVersion": "A String", # The IP version that will be used by this address. Valid options are IPV4 or IPV6. "ipv6EndpointType": "A String", # The endpoint type of this address, which should be VM or NETLB. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation. "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses. @@ -314,6 +315,7 @@

Method Details

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "description": "A String", # An optional description of this resource. Provide this field when you create the resource. "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "ipCollection": "A String", # Reference to the source of external IPv4 addresses, like a PublicDelegatedPrefix (PDP) for BYOIP. The PDP must support enhanced IPv4 allocations. Use one of the following formats to specify a PDP when reserving an external IPv4 address using BYOIP. - Full resource URL, as in https://www.googleapis.com/compute/v1/projects/projectId/regions/region /publicDelegatedPrefixes/pdp-name - Partial URL, as in - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name - regions/region/publicDelegatedPrefixes/pdp-name "ipVersion": "A String", # The IP version that will be used by this address. Valid options are IPV4 or IPV6. "ipv6EndpointType": "A String", # The endpoint type of this address, which should be VM or NETLB. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation. "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses. @@ -482,6 +484,7 @@

Method Details

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "description": "A String", # An optional description of this resource. Provide this field when you create the resource. "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "ipCollection": "A String", # Reference to the source of external IPv4 addresses, like a PublicDelegatedPrefix (PDP) for BYOIP. The PDP must support enhanced IPv4 allocations. Use one of the following formats to specify a PDP when reserving an external IPv4 address using BYOIP. - Full resource URL, as in https://www.googleapis.com/compute/v1/projects/projectId/regions/region /publicDelegatedPrefixes/pdp-name - Partial URL, as in - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name - regions/region/publicDelegatedPrefixes/pdp-name "ipVersion": "A String", # The IP version that will be used by this address. Valid options are IPV4 or IPV6. "ipv6EndpointType": "A String", # The endpoint type of this address, which should be VM or NETLB. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation. "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses. diff --git a/docs/dyn/compute_alpha.globalForwardingRules.html b/docs/dyn/compute_alpha.globalForwardingRules.html index 4e757830d36..7d4077216df 100644 --- a/docs/dyn/compute_alpha.globalForwardingRules.html +++ b/docs/dyn/compute_alpha.globalForwardingRules.html @@ -312,7 +312,6 @@

Method Details

], "subnetwork": "A String", # This field identifies the subnetwork that the load balanced IP should belong to for this forwarding rule, used with internal load balancers and external passthrough Network Load Balancers with IPv6. If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6. "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. - For load balancers, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. The target is not mutable once set as a service attachment. - "trafficDisabled": True or False, # [PSC for VPC-hosted services only] Determines if clients are allowed to access the producer service via this PSC endpoint. } @@ -387,7 +386,6 @@

Method Details

], "subnetwork": "A String", # This field identifies the subnetwork that the load balanced IP should belong to for this forwarding rule, used with internal load balancers and external passthrough Network Load Balancers with IPv6. If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6. "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. - For load balancers, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. The target is not mutable once set as a service attachment. - "trafficDisabled": True or False, # [PSC for VPC-hosted services only] Determines if clients are allowed to access the producer service via this PSC endpoint. } 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). @@ -592,7 +590,6 @@

Method Details

], "subnetwork": "A String", # This field identifies the subnetwork that the load balanced IP should belong to for this forwarding rule, used with internal load balancers and external passthrough Network Load Balancers with IPv6. If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6. "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. - For load balancers, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. The target is not mutable once set as a service attachment. - "trafficDisabled": True or False, # [PSC for VPC-hosted services only] Determines if clients are allowed to access the producer service via this PSC endpoint. }, ], "kind": "compute#forwardingRuleList", # Type of resource. @@ -697,7 +694,6 @@

Method Details

], "subnetwork": "A String", # This field identifies the subnetwork that the load balanced IP should belong to for this forwarding rule, used with internal load balancers and external passthrough Network Load Balancers with IPv6. If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6. "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. - For load balancers, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. The target is not mutable once set as a service attachment. - "trafficDisabled": True or False, # [PSC for VPC-hosted services only] Determines if clients are allowed to access the producer service via this PSC endpoint. } 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). diff --git a/docs/dyn/compute_alpha.globalPublicDelegatedPrefixes.html b/docs/dyn/compute_alpha.globalPublicDelegatedPrefixes.html index e653371b584..c2d36664488 100644 --- a/docs/dyn/compute_alpha.globalPublicDelegatedPrefixes.html +++ b/docs/dyn/compute_alpha.globalPublicDelegatedPrefixes.html @@ -246,6 +246,7 @@

Method Details

"byoipApiVersion": "A String", # [Output Only] The version of BYOIP API. "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. + "enableEnhancedIpv4Allocation": True or False, # [Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only. "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix. "id": "A String", # [Output Only] The unique identifier for the resource type. The server generates this identifier. "ipCidrRange": "A String", # The IP address range, in CIDR format, represented by this public delegated prefix. @@ -260,6 +261,7 @@

Method Details

"allocatablePrefixLength": 42, # The allocatable prefix length supported by this PublicDelegatedSubPrefix. "delegateeProject": "A String", # Name of the project scoping this PublicDelegatedSubPrefix. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "enableEnhancedIpv4Allocation": True or False, # [Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only. "ipCidrRange": "A String", # The IP address range, in CIDR format, represented by this sub public delegated prefix. "ipv6AccessType": "A String", # [Output Only] The internet access type for IPv6 Public Delegated Sub Prefixes. Inherited from parent prefix. "isAddress": True or False, # Whether the sub prefix is delegated to create Address resources in the delegatee project. @@ -292,6 +294,7 @@

Method Details

"byoipApiVersion": "A String", # [Output Only] The version of BYOIP API. "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. + "enableEnhancedIpv4Allocation": True or False, # [Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only. "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix. "id": "A String", # [Output Only] The unique identifier for the resource type. The server generates this identifier. "ipCidrRange": "A String", # The IP address range, in CIDR format, represented by this public delegated prefix. @@ -306,6 +309,7 @@

Method Details

"allocatablePrefixLength": 42, # The allocatable prefix length supported by this PublicDelegatedSubPrefix. "delegateeProject": "A String", # Name of the project scoping this PublicDelegatedSubPrefix. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "enableEnhancedIpv4Allocation": True or False, # [Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only. "ipCidrRange": "A String", # The IP address range, in CIDR format, represented by this sub public delegated prefix. "ipv6AccessType": "A String", # [Output Only] The internet access type for IPv6 Public Delegated Sub Prefixes. Inherited from parent prefix. "isAddress": True or False, # Whether the sub prefix is delegated to create Address resources in the delegatee project. @@ -468,6 +472,7 @@

Method Details

"byoipApiVersion": "A String", # [Output Only] The version of BYOIP API. "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. + "enableEnhancedIpv4Allocation": True or False, # [Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only. "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix. "id": "A String", # [Output Only] The unique identifier for the resource type. The server generates this identifier. "ipCidrRange": "A String", # The IP address range, in CIDR format, represented by this public delegated prefix. @@ -482,6 +487,7 @@

Method Details

"allocatablePrefixLength": 42, # The allocatable prefix length supported by this PublicDelegatedSubPrefix. "delegateeProject": "A String", # Name of the project scoping this PublicDelegatedSubPrefix. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "enableEnhancedIpv4Allocation": True or False, # [Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only. "ipCidrRange": "A String", # The IP address range, in CIDR format, represented by this sub public delegated prefix. "ipv6AccessType": "A String", # [Output Only] The internet access type for IPv6 Public Delegated Sub Prefixes. Inherited from parent prefix. "isAddress": True or False, # Whether the sub prefix is delegated to create Address resources in the delegatee project. @@ -544,6 +550,7 @@

Method Details

"byoipApiVersion": "A String", # [Output Only] The version of BYOIP API. "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. + "enableEnhancedIpv4Allocation": True or False, # [Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only. "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix. "id": "A String", # [Output Only] The unique identifier for the resource type. The server generates this identifier. "ipCidrRange": "A String", # The IP address range, in CIDR format, represented by this public delegated prefix. @@ -558,6 +565,7 @@

Method Details

"allocatablePrefixLength": 42, # The allocatable prefix length supported by this PublicDelegatedSubPrefix. "delegateeProject": "A String", # Name of the project scoping this PublicDelegatedSubPrefix. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "enableEnhancedIpv4Allocation": True or False, # [Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only. "ipCidrRange": "A String", # The IP address range, in CIDR format, represented by this sub public delegated prefix. "ipv6AccessType": "A String", # [Output Only] The internet access type for IPv6 Public Delegated Sub Prefixes. Inherited from parent prefix. "isAddress": True or False, # Whether the sub prefix is delegated to create Address resources in the delegatee project. diff --git a/docs/dyn/compute_alpha.instanceTemplates.html b/docs/dyn/compute_alpha.instanceTemplates.html index 923213e3d9f..5fd44f6a9b9 100644 --- a/docs/dyn/compute_alpha.instanceTemplates.html +++ b/docs/dyn/compute_alpha.instanceTemplates.html @@ -326,6 +326,7 @@

Method Details

"subnetworkRangeName": "A String", # 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. }, ], + "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid with network_attachment. "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "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. @@ -883,6 +884,7 @@

Method Details

"subnetworkRangeName": "A String", # 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. }, ], + "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid with network_attachment. "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "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. @@ -1307,6 +1309,7 @@

Method Details

"subnetworkRangeName": "A String", # 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. }, ], + "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid with network_attachment. "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "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. @@ -1817,6 +1820,7 @@

Method Details

"subnetworkRangeName": "A String", # 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. }, ], + "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid with network_attachment. "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "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. diff --git a/docs/dyn/compute_alpha.instances.html b/docs/dyn/compute_alpha.instances.html index 5e06bda76c9..6492c49695b 100644 --- a/docs/dyn/compute_alpha.instances.html +++ b/docs/dyn/compute_alpha.instances.html @@ -434,6 +434,7 @@

Method Details

"subnetworkRangeName": "A String", # 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. }, ], + "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid with network_attachment. "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "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. @@ -961,6 +962,7 @@

Method Details

"subnetworkRangeName": "A String", # 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. }, ], + "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid with network_attachment. "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "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. @@ -1868,6 +1870,7 @@

Method Details

"subnetworkRangeName": "A String", # 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. }, ], + "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid with network_attachment. "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "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. @@ -2909,6 +2912,7 @@

Method Details

"subnetworkRangeName": "A String", # 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. }, ], + "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid with network_attachment. "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "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. @@ -4085,6 +4089,7 @@

Method Details

"subnetworkRangeName": "A String", # 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. }, ], + "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid with network_attachment. "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "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. @@ -4736,6 +4741,7 @@

Method Details

"subnetworkRangeName": "A String", # 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. }, ], + "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid with network_attachment. "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "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. @@ -8893,6 +8899,7 @@

Method Details

"subnetworkRangeName": "A String", # 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. }, ], + "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid with network_attachment. "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "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. @@ -9634,6 +9641,7 @@

Method Details

"subnetworkRangeName": "A String", # 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. }, ], + "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid with network_attachment. "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "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. diff --git a/docs/dyn/compute_alpha.machineImages.html b/docs/dyn/compute_alpha.machineImages.html index 49396f9a9c9..269c6a65fdf 100644 --- a/docs/dyn/compute_alpha.machineImages.html +++ b/docs/dyn/compute_alpha.machineImages.html @@ -441,6 +441,7 @@

Method Details

"subnetworkRangeName": "A String", # 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. }, ], + "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid with network_attachment. "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "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. @@ -727,6 +728,7 @@

Method Details

"subnetworkRangeName": "A String", # 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. }, ], + "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid with network_attachment. "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "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. @@ -1096,6 +1098,7 @@

Method Details

"subnetworkRangeName": "A String", # 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. }, ], + "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid with network_attachment. "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "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. @@ -1382,6 +1385,7 @@

Method Details

"subnetworkRangeName": "A String", # 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. }, ], + "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid with network_attachment. "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "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. @@ -1833,6 +1837,7 @@

Method Details

"subnetworkRangeName": "A String", # 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. }, ], + "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid with network_attachment. "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "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. @@ -2119,6 +2124,7 @@

Method Details

"subnetworkRangeName": "A String", # 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. }, ], + "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid with network_attachment. "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "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. diff --git a/docs/dyn/compute_alpha.publicDelegatedPrefixes.html b/docs/dyn/compute_alpha.publicDelegatedPrefixes.html index 6c272f01e53..99a4fba943a 100644 --- a/docs/dyn/compute_alpha.publicDelegatedPrefixes.html +++ b/docs/dyn/compute_alpha.publicDelegatedPrefixes.html @@ -139,6 +139,7 @@

Method Details

"byoipApiVersion": "A String", # [Output Only] The version of BYOIP API. "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. + "enableEnhancedIpv4Allocation": True or False, # [Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only. "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix. "id": "A String", # [Output Only] The unique identifier for the resource type. The server generates this identifier. "ipCidrRange": "A String", # The IP address range, in CIDR format, represented by this public delegated prefix. @@ -153,6 +154,7 @@

Method Details

"allocatablePrefixLength": 42, # The allocatable prefix length supported by this PublicDelegatedSubPrefix. "delegateeProject": "A String", # Name of the project scoping this PublicDelegatedSubPrefix. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "enableEnhancedIpv4Allocation": True or False, # [Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only. "ipCidrRange": "A String", # The IP address range, in CIDR format, represented by this sub public delegated prefix. "ipv6AccessType": "A String", # [Output Only] The internet access type for IPv6 Public Delegated Sub Prefixes. Inherited from parent prefix. "isAddress": True or False, # Whether the sub prefix is delegated to create Address resources in the delegatee project. @@ -493,6 +495,7 @@

Method Details

"byoipApiVersion": "A String", # [Output Only] The version of BYOIP API. "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. + "enableEnhancedIpv4Allocation": True or False, # [Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only. "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix. "id": "A String", # [Output Only] The unique identifier for the resource type. The server generates this identifier. "ipCidrRange": "A String", # The IP address range, in CIDR format, represented by this public delegated prefix. @@ -507,6 +510,7 @@

Method Details

"allocatablePrefixLength": 42, # The allocatable prefix length supported by this PublicDelegatedSubPrefix. "delegateeProject": "A String", # Name of the project scoping this PublicDelegatedSubPrefix. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "enableEnhancedIpv4Allocation": True or False, # [Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only. "ipCidrRange": "A String", # The IP address range, in CIDR format, represented by this sub public delegated prefix. "ipv6AccessType": "A String", # [Output Only] The internet access type for IPv6 Public Delegated Sub Prefixes. Inherited from parent prefix. "isAddress": True or False, # Whether the sub prefix is delegated to create Address resources in the delegatee project. @@ -540,6 +544,7 @@

Method Details

"byoipApiVersion": "A String", # [Output Only] The version of BYOIP API. "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. + "enableEnhancedIpv4Allocation": True or False, # [Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only. "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix. "id": "A String", # [Output Only] The unique identifier for the resource type. The server generates this identifier. "ipCidrRange": "A String", # The IP address range, in CIDR format, represented by this public delegated prefix. @@ -554,6 +559,7 @@

Method Details

"allocatablePrefixLength": 42, # The allocatable prefix length supported by this PublicDelegatedSubPrefix. "delegateeProject": "A String", # Name of the project scoping this PublicDelegatedSubPrefix. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "enableEnhancedIpv4Allocation": True or False, # [Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only. "ipCidrRange": "A String", # The IP address range, in CIDR format, represented by this sub public delegated prefix. "ipv6AccessType": "A String", # [Output Only] The internet access type for IPv6 Public Delegated Sub Prefixes. Inherited from parent prefix. "isAddress": True or False, # Whether the sub prefix is delegated to create Address resources in the delegatee project. @@ -717,6 +723,7 @@

Method Details

"byoipApiVersion": "A String", # [Output Only] The version of BYOIP API. "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. + "enableEnhancedIpv4Allocation": True or False, # [Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only. "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix. "id": "A String", # [Output Only] The unique identifier for the resource type. The server generates this identifier. "ipCidrRange": "A String", # The IP address range, in CIDR format, represented by this public delegated prefix. @@ -731,6 +738,7 @@

Method Details

"allocatablePrefixLength": 42, # The allocatable prefix length supported by this PublicDelegatedSubPrefix. "delegateeProject": "A String", # Name of the project scoping this PublicDelegatedSubPrefix. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "enableEnhancedIpv4Allocation": True or False, # [Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only. "ipCidrRange": "A String", # The IP address range, in CIDR format, represented by this sub public delegated prefix. "ipv6AccessType": "A String", # [Output Only] The internet access type for IPv6 Public Delegated Sub Prefixes. Inherited from parent prefix. "isAddress": True or False, # Whether the sub prefix is delegated to create Address resources in the delegatee project. @@ -794,6 +802,7 @@

Method Details

"byoipApiVersion": "A String", # [Output Only] The version of BYOIP API. "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. + "enableEnhancedIpv4Allocation": True or False, # [Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only. "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix. "id": "A String", # [Output Only] The unique identifier for the resource type. The server generates this identifier. "ipCidrRange": "A String", # The IP address range, in CIDR format, represented by this public delegated prefix. @@ -808,6 +817,7 @@

Method Details

"allocatablePrefixLength": 42, # The allocatable prefix length supported by this PublicDelegatedSubPrefix. "delegateeProject": "A String", # Name of the project scoping this PublicDelegatedSubPrefix. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "enableEnhancedIpv4Allocation": True or False, # [Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only. "ipCidrRange": "A String", # The IP address range, in CIDR format, represented by this sub public delegated prefix. "ipv6AccessType": "A String", # [Output Only] The internet access type for IPv6 Public Delegated Sub Prefixes. Inherited from parent prefix. "isAddress": True or False, # Whether the sub prefix is delegated to create Address resources in the delegatee project. diff --git a/docs/dyn/compute_alpha.regionDisks.html b/docs/dyn/compute_alpha.regionDisks.html index 0bef42b015c..e9d90cec6ad 100644 --- a/docs/dyn/compute_alpha.regionDisks.html +++ b/docs/dyn/compute_alpha.regionDisks.html @@ -434,7 +434,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. LINT.IfChange +{ # Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. "architecture": "A String", # [Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64. "autoCreated": True or False, # [Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk. "chainName": "A String", # Creates the new snapshot in the snapshot chain labeled with the specified name. The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value. diff --git a/docs/dyn/compute_alpha.regionInstanceTemplates.html b/docs/dyn/compute_alpha.regionInstanceTemplates.html index 110e347b97e..903597f4c71 100644 --- a/docs/dyn/compute_alpha.regionInstanceTemplates.html +++ b/docs/dyn/compute_alpha.regionInstanceTemplates.html @@ -437,6 +437,7 @@

Method Details

"subnetworkRangeName": "A String", # 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. }, ], + "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid with network_attachment. "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "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. @@ -813,6 +814,7 @@

Method Details

"subnetworkRangeName": "A String", # 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. }, ], + "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid with network_attachment. "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "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. @@ -1324,6 +1326,7 @@

Method Details

"subnetworkRangeName": "A String", # 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. }, ], + "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid with network_attachment. "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "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. diff --git a/docs/dyn/compute_alpha.regionInstances.html b/docs/dyn/compute_alpha.regionInstances.html index da90c3efa5b..3414a6728ef 100644 --- a/docs/dyn/compute_alpha.regionInstances.html +++ b/docs/dyn/compute_alpha.regionInstances.html @@ -403,6 +403,7 @@

Method Details

"subnetworkRangeName": "A String", # 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. }, ], + "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid with network_attachment. "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date. "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. diff --git a/docs/dyn/compute_alpha.regionNetworkPolicies.html b/docs/dyn/compute_alpha.regionNetworkPolicies.html index 8a45d8b8645..9aef6d6e6bc 100644 --- a/docs/dyn/compute_alpha.regionNetworkPolicies.html +++ b/docs/dyn/compute_alpha.regionNetworkPolicies.html @@ -82,7 +82,7 @@

Instance Methods

Inserts a rule into a network policy.

aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)

-

Retrieves an aggregated list of network policies. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.

+

Retrieves an aggregated list of network policies. To prevent failure, it's recommended that you set the `returnPartialSuccess` parameter to `true`.

aggregatedList_next()

Retrieves the next page of results.

@@ -270,8 +270,11 @@

Method Details

{ # Represents a traffic classification rule that describes one or more match conditions along with the action to be taken when traffic matches this condition. "action": { # The Action to perform when the client connection triggers the rule. + "dscpMode": "A String", # The traffic class that should be applied to the matching packet. + "dscpValue": 42, # Custom DSCP value from 0-63 range. "fieldType": "A String", # The field type could be one of: TRAFFIC_CLASS or DSCP. "fieldValue": 42, # For field_type = TRAFFIC_CLASS: 1 to 6. For field_type = DSCP: 0 to 63. + "trafficClass": "A String", # The traffic class that should be applied to the matching packet. "type": "A String", # Always "apply_traffic_classification" for traffic classification rules. }, "description": "A String", # An optional description for this resource. @@ -427,7 +430,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 network policies. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
+  
Retrieves an aggregated list of network policies. To prevent failure, it's recommended that you set the `returnPartialSuccess` parameter to `true`.
 
 Args:
   project: string, Project ID for this request. (required)
@@ -470,8 +473,11 @@ 
Method Details

           "trafficClassificationRules": [ # [Output Only] A list of traffic classification rules that belong to this policy.
             { # Represents a traffic classification rule that describes one or more match conditions along with the action to be taken when traffic matches this condition.
               "action": { # The Action to perform when the client connection triggers the rule.
+                "dscpMode": "A String", # The traffic class that should be applied to the matching packet.
+                "dscpValue": 42, # Custom DSCP value from 0-63 range.
                 "fieldType": "A String", # The field type could be one of: TRAFFIC_CLASS or DSCP.
                 "fieldValue": 42, # For field_type = TRAFFIC_CLASS: 1 to 6. For field_type = DSCP: 0 to 63.
+                "trafficClass": "A String", # The traffic class that should be applied to the matching packet.
                 "type": "A String", # Always "apply_traffic_classification" for traffic classification rules.
               },
               "description": "A String", # An optional description for this resource.
@@ -720,8 +726,11 @@ 
Method Details

   "trafficClassificationRules": [ # [Output Only] A list of traffic classification rules that belong to this policy.
     { # Represents a traffic classification rule that describes one or more match conditions along with the action to be taken when traffic matches this condition.
       "action": { # The Action to perform when the client connection triggers the rule.
+        "dscpMode": "A String", # The traffic class that should be applied to the matching packet.
+        "dscpValue": 42, # Custom DSCP value from 0-63 range.
         "fieldType": "A String", # The field type could be one of: TRAFFIC_CLASS or DSCP.
         "fieldValue": 42, # For field_type = TRAFFIC_CLASS: 1 to 6. For field_type = DSCP: 0 to 63.
+        "trafficClass": "A String", # The traffic class that should be applied to the matching packet.
         "type": "A String", # Always "apply_traffic_classification" for traffic classification rules.
       },
       "description": "A String", # An optional description for this resource.
@@ -802,8 +811,11 @@ 
Method Details

 
     { # Represents a traffic classification rule that describes one or more match conditions along with the action to be taken when traffic matches this condition.
   "action": { # The Action to perform when the client connection triggers the rule.
+    "dscpMode": "A String", # The traffic class that should be applied to the matching packet.
+    "dscpValue": 42, # Custom DSCP value from 0-63 range.
     "fieldType": "A String", # The field type could be one of: TRAFFIC_CLASS or DSCP.
     "fieldValue": 42, # For field_type = TRAFFIC_CLASS: 1 to 6. For field_type = DSCP: 0 to 63.
+    "trafficClass": "A String", # The traffic class that should be applied to the matching packet.
     "type": "A String", # Always "apply_traffic_classification" for traffic classification rules.
   },
   "description": "A String", # An optional description for this resource.
@@ -869,8 +881,11 @@ 
Method Details

   "trafficClassificationRules": [ # [Output Only] A list of traffic classification rules that belong to this policy.
     { # Represents a traffic classification rule that describes one or more match conditions along with the action to be taken when traffic matches this condition.
       "action": { # The Action to perform when the client connection triggers the rule.
+        "dscpMode": "A String", # The traffic class that should be applied to the matching packet.
+        "dscpValue": 42, # Custom DSCP value from 0-63 range.
         "fieldType": "A String", # The field type could be one of: TRAFFIC_CLASS or DSCP.
         "fieldValue": 42, # For field_type = TRAFFIC_CLASS: 1 to 6. For field_type = DSCP: 0 to 63.
+        "trafficClass": "A String", # The traffic class that should be applied to the matching packet.
         "type": "A String", # Always "apply_traffic_classification" for traffic classification rules.
       },
       "description": "A String", # An optional description for this resource.
@@ -1068,8 +1083,11 @@ 
Method Details

       "trafficClassificationRules": [ # [Output Only] A list of traffic classification rules that belong to this policy.
         { # Represents a traffic classification rule that describes one or more match conditions along with the action to be taken when traffic matches this condition.
           "action": { # The Action to perform when the client connection triggers the rule.
+            "dscpMode": "A String", # The traffic class that should be applied to the matching packet.
+            "dscpValue": 42, # Custom DSCP value from 0-63 range.
             "fieldType": "A String", # The field type could be one of: TRAFFIC_CLASS or DSCP.
             "fieldValue": 42, # For field_type = TRAFFIC_CLASS: 1 to 6. For field_type = DSCP: 0 to 63.
+            "trafficClass": "A String", # The traffic class that should be applied to the matching packet.
             "type": "A String", # Always "apply_traffic_classification" for traffic classification rules.
           },
           "description": "A String", # An optional description for this resource.
@@ -1166,8 +1184,11 @@ 
Method Details

   "trafficClassificationRules": [ # [Output Only] A list of traffic classification rules that belong to this policy.
     { # Represents a traffic classification rule that describes one or more match conditions along with the action to be taken when traffic matches this condition.
       "action": { # The Action to perform when the client connection triggers the rule.
+        "dscpMode": "A String", # The traffic class that should be applied to the matching packet.
+        "dscpValue": 42, # Custom DSCP value from 0-63 range.
         "fieldType": "A String", # The field type could be one of: TRAFFIC_CLASS or DSCP.
         "fieldValue": 42, # For field_type = TRAFFIC_CLASS: 1 to 6. For field_type = DSCP: 0 to 63.
+        "trafficClass": "A String", # The traffic class that should be applied to the matching packet.
         "type": "A String", # Always "apply_traffic_classification" for traffic classification rules.
       },
       "description": "A String", # An optional description for this resource.
@@ -1336,8 +1357,11 @@ 
Method Details

 
 { # Represents a traffic classification rule that describes one or more match conditions along with the action to be taken when traffic matches this condition.
   "action": { # The Action to perform when the client connection triggers the rule.
+    "dscpMode": "A String", # The traffic class that should be applied to the matching packet.
+    "dscpValue": 42, # Custom DSCP value from 0-63 range.
     "fieldType": "A String", # The field type could be one of: TRAFFIC_CLASS or DSCP.
     "fieldValue": 42, # For field_type = TRAFFIC_CLASS: 1 to 6. For field_type = DSCP: 0 to 63.
+    "trafficClass": "A String", # The traffic class that should be applied to the matching packet.
     "type": "A String", # Always "apply_traffic_classification" for traffic classification rules.
   },
   "description": "A String", # An optional description for this resource.
@@ -1373,7 +1397,7 @@ 
Method Details

   ],
 }
 
-  priority: integer, The priority of the rule to patch.
+  priority: integer, The priority of the traffic classification rule to patch. Only rules with a priority value between 1 and 2147482647 (inclusive) can be patched.
   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
diff --git a/docs/dyn/compute_alpha.regionSnapshots.html b/docs/dyn/compute_alpha.regionSnapshots.html
index 9eee23f6249..8cf87dedfa5 100644
--- a/docs/dyn/compute_alpha.regionSnapshots.html
+++ b/docs/dyn/compute_alpha.regionSnapshots.html
@@ -255,7 +255,7 @@ 
Method Details

 Returns:
   An object of the form:
 
-    { # Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. LINT.IfChange
+    { # Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots.
   "architecture": "A String", # [Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64.
   "autoCreated": True or False, # [Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk.
   "chainName": "A String", # Creates the new snapshot in the snapshot chain labeled with the specified name. The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value.
@@ -402,7 +402,7 @@ 
Method Details

   body: object, The request body.
     The object takes the form of:
 
-{ # Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. LINT.IfChange
+{ # Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots.
   "architecture": "A String", # [Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64.
   "autoCreated": True or False, # [Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk.
   "chainName": "A String", # Creates the new snapshot in the snapshot chain labeled with the specified name. The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value.
@@ -629,7 +629,7 @@ 
Method Details

     { # Contains a list of Snapshot resources.
   "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
   "items": [ # A list of Snapshot resources.
-    { # Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. LINT.IfChange
+    { # Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots.
       "architecture": "A String", # [Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64.
       "autoCreated": True or False, # [Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk.
       "chainName": "A String", # Creates the new snapshot in the snapshot chain labeled with the specified name. The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value.
diff --git a/docs/dyn/compute_alpha.routers.html b/docs/dyn/compute_alpha.routers.html
index 80671f101cd..7cc72976e6b 100644
--- a/docs/dyn/compute_alpha.routers.html
+++ b/docs/dyn/compute_alpha.routers.html
@@ -1006,6 +1006,7 @@ 
Method Details

     {
   "etag": "A String", # end_interface: MixerGetResponseWithEtagBuilder
   "resource": {
+    "description": "A String", # An optional description of named set.
     "elements": [ # CEL expressions that are comparable to constructs of this set's type (see Policy Language).
       { # 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.
         "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.
@@ -2159,6 +2160,7 @@ 
Method Details

   "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 than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
   "result": [ # [Output Only] A list of named sets.
     {
+      "description": "A String", # An optional description of named set.
       "elements": [ # CEL expressions that are comparable to constructs of this set's type (see Policy Language).
         { # 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.
           "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.
@@ -2616,6 +2618,7 @@ 
Method Details

     The object takes the form of:
 
 {
+  "description": "A String", # An optional description of named set.
   "elements": [ # CEL expressions that are comparable to constructs of this set's type (see Policy Language).
     { # 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.
       "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.
@@ -3619,6 +3622,7 @@ 
Method Details

     The object takes the form of:
 
 {
+  "description": "A String", # An optional description of named set.
   "elements": [ # CEL expressions that are comparable to constructs of this set's type (see Policy Language).
     { # 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.
       "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.
diff --git a/docs/dyn/compute_alpha.snapshots.html b/docs/dyn/compute_alpha.snapshots.html
index f876bd8000d..6b6fe64edbc 100644
--- a/docs/dyn/compute_alpha.snapshots.html
+++ b/docs/dyn/compute_alpha.snapshots.html
@@ -141,7 +141,7 @@ 
Method Details

   "items": { # A list of SnapshotsScopedList resources.
     "a_key": { # [Output Only] Name of the scope containing this set of snapshots.
       "snapshots": [ # [Output Only] A list of snapshots contained in this scope.
-        { # Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. LINT.IfChange
+        { # Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots.
           "architecture": "A String", # [Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64.
           "autoCreated": True or False, # [Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk.
           "chainName": "A String", # Creates the new snapshot in the snapshot chain labeled with the specified name. The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value.
@@ -417,7 +417,7 @@ 
Method Details

 Returns:
   An object of the form:
 
-    { # Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. LINT.IfChange
+    { # Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots.
   "architecture": "A String", # [Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64.
   "autoCreated": True or False, # [Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk.
   "chainName": "A String", # Creates the new snapshot in the snapshot chain labeled with the specified name. The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value.
@@ -562,7 +562,7 @@ 
Method Details

   body: object, The request body.
     The object takes the form of:
 
-{ # Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. LINT.IfChange
+{ # Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots.
   "architecture": "A String", # [Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64.
   "autoCreated": True or False, # [Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk.
   "chainName": "A String", # Creates the new snapshot in the snapshot chain labeled with the specified name. The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value.
@@ -788,7 +788,7 @@ 
Method Details

     { # Contains a list of Snapshot resources.
   "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
   "items": [ # A list of Snapshot resources.
-    { # Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. LINT.IfChange
+    { # Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots.
       "architecture": "A String", # [Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64.
       "autoCreated": True or False, # [Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk.
       "chainName": "A String", # Creates the new snapshot in the snapshot chain labeled with the specified name. The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value.
diff --git a/docs/dyn/compute_alpha.zoneQueuedResources.html b/docs/dyn/compute_alpha.zoneQueuedResources.html
index 334db930cf0..1d0b7838987 100644
--- a/docs/dyn/compute_alpha.zoneQueuedResources.html
+++ b/docs/dyn/compute_alpha.zoneQueuedResources.html
@@ -441,6 +441,7 @@ 
Method Details

                       "subnetworkRangeName": "A String", # 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.
                     },
                   ],
+                  "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid with network_attachment.
                   "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.
                   "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.
@@ -1327,6 +1328,7 @@ 
Method Details

               "subnetworkRangeName": "A String", # 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.
             },
           ],
+          "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid with network_attachment.
           "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.
           "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.
@@ -1906,6 +1908,7 @@ 
Method Details

               "subnetworkRangeName": "A String", # 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.
             },
           ],
+          "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid with network_attachment.
           "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.
           "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.
@@ -2615,6 +2618,7 @@ 
Method Details

                   "subnetworkRangeName": "A String", # 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.
                 },
               ],
+              "enableVpcScopedDns": True or False, # Optional. If true, DNS resolution will be enabled over this interface. Only valid with network_attachment.
               "fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.
               "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.
diff --git a/docs/dyn/compute_beta.addresses.html b/docs/dyn/compute_beta.addresses.html
index 92775a57966..e8e6956f27c 100644
--- a/docs/dyn/compute_beta.addresses.html
+++ b/docs/dyn/compute_beta.addresses.html
@@ -140,6 +140,7 @@ 
Method Details

           "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
           "description": "A String", # An optional description of this resource. Provide this field when you create the resource.
           "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+          "ipCollection": "A String", # Reference to the source of external IPv4 addresses, like a PublicDelegatedPrefix (PDP) for BYOIP. The PDP must support enhanced IPv4 allocations. Use one of the following formats to specify a PDP when reserving an external IPv4 address using BYOIP. - Full resource URL, as in https://www.googleapis.com/compute/v1/projects/projectId/regions/region /publicDelegatedPrefixes/pdp-name - Partial URL, as in - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name - regions/region/publicDelegatedPrefixes/pdp-name
           "ipVersion": "A String", # The IP version that will be used by this address. Valid options are IPV4 or IPV6.
           "ipv6EndpointType": "A String", # The endpoint type of this address, which should be VM or NETLB. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation.
           "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
@@ -358,6 +359,7 @@ 
Method Details

   "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
   "description": "A String", # An optional description of this resource. Provide this field when you create the resource.
   "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+  "ipCollection": "A String", # Reference to the source of external IPv4 addresses, like a PublicDelegatedPrefix (PDP) for BYOIP. The PDP must support enhanced IPv4 allocations. Use one of the following formats to specify a PDP when reserving an external IPv4 address using BYOIP. - Full resource URL, as in https://www.googleapis.com/compute/v1/projects/projectId/regions/region /publicDelegatedPrefixes/pdp-name - Partial URL, as in - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name - regions/region/publicDelegatedPrefixes/pdp-name
   "ipVersion": "A String", # The IP version that will be used by this address. Valid options are IPV4 or IPV6.
   "ipv6EndpointType": "A String", # The endpoint type of this address, which should be VM or NETLB. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation.
   "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
@@ -396,6 +398,7 @@ 
Method Details

   "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
   "description": "A String", # An optional description of this resource. Provide this field when you create the resource.
   "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+  "ipCollection": "A String", # Reference to the source of external IPv4 addresses, like a PublicDelegatedPrefix (PDP) for BYOIP. The PDP must support enhanced IPv4 allocations. Use one of the following formats to specify a PDP when reserving an external IPv4 address using BYOIP. - Full resource URL, as in https://www.googleapis.com/compute/v1/projects/projectId/regions/region /publicDelegatedPrefixes/pdp-name - Partial URL, as in - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name - regions/region/publicDelegatedPrefixes/pdp-name
   "ipVersion": "A String", # The IP version that will be used by this address. Valid options are IPV4 or IPV6.
   "ipv6EndpointType": "A String", # The endpoint type of this address, which should be VM or NETLB. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation.
   "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
@@ -563,6 +566,7 @@ 
Method Details

       "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
       "description": "A String", # An optional description of this resource. Provide this field when you create the resource.
       "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+      "ipCollection": "A String", # Reference to the source of external IPv4 addresses, like a PublicDelegatedPrefix (PDP) for BYOIP. The PDP must support enhanced IPv4 allocations. Use one of the following formats to specify a PDP when reserving an external IPv4 address using BYOIP. - Full resource URL, as in https://www.googleapis.com/compute/v1/projects/projectId/regions/region /publicDelegatedPrefixes/pdp-name - Partial URL, as in - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name - regions/region/publicDelegatedPrefixes/pdp-name
       "ipVersion": "A String", # The IP version that will be used by this address. Valid options are IPV4 or IPV6.
       "ipv6EndpointType": "A String", # The endpoint type of this address, which should be VM or NETLB. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation.
       "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
diff --git a/docs/dyn/compute_beta.disks.html b/docs/dyn/compute_beta.disks.html
index 4aabb1785bb..3e5c371eaf3 100644
--- a/docs/dyn/compute_beta.disks.html
+++ b/docs/dyn/compute_beta.disks.html
@@ -754,7 +754,7 @@ 
Method Details

   body: object, The request body.
     The object takes the form of:
 
-{ # Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. LINT.IfChange
+{ # Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots.
   "architecture": "A String", # [Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64.
   "autoCreated": True or False, # [Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk.
   "chainName": "A String", # Creates the new snapshot in the snapshot chain labeled with the specified name. The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value.
@@ -784,6 +784,11 @@ 
Method Details

   ],
   "locationHint": "A String", # An opaque location hint used to place the snapshot close to other resources. This field is for use by internal tools that use the public API.
   "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 with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+  "params": { # Additional snapshot params. # Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.
+    "resourceManagerTags": { # Resource manager tags to be bound to the snapshot. 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",
+    },
+  },
   "region": "A String", # [Output Only] URL of the region where the snapshot resides. Only applicable for regional snapshots.
   "satisfiesPzi": True or False, # Output only. Reserved for future use.
   "satisfiesPzs": True or False, # [Output Only] Reserved for future use.
diff --git a/docs/dyn/compute_beta.globalAddresses.html b/docs/dyn/compute_beta.globalAddresses.html
index e9e8ddf48eb..4ded531c69b 100644
--- a/docs/dyn/compute_beta.globalAddresses.html
+++ b/docs/dyn/compute_beta.globalAddresses.html
@@ -252,6 +252,7 @@ 
Method Details

   "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
   "description": "A String", # An optional description of this resource. Provide this field when you create the resource.
   "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+  "ipCollection": "A String", # Reference to the source of external IPv4 addresses, like a PublicDelegatedPrefix (PDP) for BYOIP. The PDP must support enhanced IPv4 allocations. Use one of the following formats to specify a PDP when reserving an external IPv4 address using BYOIP. - Full resource URL, as in https://www.googleapis.com/compute/v1/projects/projectId/regions/region /publicDelegatedPrefixes/pdp-name - Partial URL, as in - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name - regions/region/publicDelegatedPrefixes/pdp-name
   "ipVersion": "A String", # The IP version that will be used by this address. Valid options are IPV4 or IPV6.
   "ipv6EndpointType": "A String", # The endpoint type of this address, which should be VM or NETLB. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation.
   "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
@@ -289,6 +290,7 @@ 
Method Details

   "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
   "description": "A String", # An optional description of this resource. Provide this field when you create the resource.
   "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+  "ipCollection": "A String", # Reference to the source of external IPv4 addresses, like a PublicDelegatedPrefix (PDP) for BYOIP. The PDP must support enhanced IPv4 allocations. Use one of the following formats to specify a PDP when reserving an external IPv4 address using BYOIP. - Full resource URL, as in https://www.googleapis.com/compute/v1/projects/projectId/regions/region /publicDelegatedPrefixes/pdp-name - Partial URL, as in - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name - regions/region/publicDelegatedPrefixes/pdp-name
   "ipVersion": "A String", # The IP version that will be used by this address. Valid options are IPV4 or IPV6.
   "ipv6EndpointType": "A String", # The endpoint type of this address, which should be VM or NETLB. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation.
   "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
@@ -455,6 +457,7 @@ 
Method Details

       "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
       "description": "A String", # An optional description of this resource. Provide this field when you create the resource.
       "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+      "ipCollection": "A String", # Reference to the source of external IPv4 addresses, like a PublicDelegatedPrefix (PDP) for BYOIP. The PDP must support enhanced IPv4 allocations. Use one of the following formats to specify a PDP when reserving an external IPv4 address using BYOIP. - Full resource URL, as in https://www.googleapis.com/compute/v1/projects/projectId/regions/region /publicDelegatedPrefixes/pdp-name - Partial URL, as in - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name - regions/region/publicDelegatedPrefixes/pdp-name
       "ipVersion": "A String", # The IP version that will be used by this address. Valid options are IPV4 or IPV6.
       "ipv6EndpointType": "A String", # The endpoint type of this address, which should be VM or NETLB. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation.
       "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
diff --git a/docs/dyn/compute_beta.globalPublicDelegatedPrefixes.html b/docs/dyn/compute_beta.globalPublicDelegatedPrefixes.html
index fb1e6633fd9..7d2dd8d543d 100644
--- a/docs/dyn/compute_beta.globalPublicDelegatedPrefixes.html
+++ b/docs/dyn/compute_beta.globalPublicDelegatedPrefixes.html
@@ -245,6 +245,7 @@ 
Method Details

   "byoipApiVersion": "A String", # [Output Only] The version of BYOIP API.
   "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.
+  "enableEnhancedIpv4Allocation": True or False, # [Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only.
   "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix.
   "id": "A String", # [Output Only] The unique identifier for the resource type. The server generates this identifier.
   "ipCidrRange": "A String", # The IP address range, in CIDR format, represented by this public delegated prefix.
@@ -258,6 +259,7 @@ 
Method Details

       "allocatablePrefixLength": 42, # The allocatable prefix length supported by this PublicDelegatedSubPrefix.
       "delegateeProject": "A String", # Name of the project scoping this PublicDelegatedSubPrefix.
       "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+      "enableEnhancedIpv4Allocation": True or False, # [Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only.
       "ipCidrRange": "A String", # The IP address range, in CIDR format, represented by this sub public delegated prefix.
       "isAddress": True or False, # Whether the sub prefix is delegated to create Address resources in the delegatee project.
       "mode": "A String", # The PublicDelegatedSubPrefix mode for IPv6 only.
@@ -286,6 +288,7 @@ 
Method Details

   "byoipApiVersion": "A String", # [Output Only] The version of BYOIP API.
   "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.
+  "enableEnhancedIpv4Allocation": True or False, # [Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only.
   "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix.
   "id": "A String", # [Output Only] The unique identifier for the resource type. The server generates this identifier.
   "ipCidrRange": "A String", # The IP address range, in CIDR format, represented by this public delegated prefix.
@@ -299,6 +302,7 @@ 
Method Details

       "allocatablePrefixLength": 42, # The allocatable prefix length supported by this PublicDelegatedSubPrefix.
       "delegateeProject": "A String", # Name of the project scoping this PublicDelegatedSubPrefix.
       "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+      "enableEnhancedIpv4Allocation": True or False, # [Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only.
       "ipCidrRange": "A String", # The IP address range, in CIDR format, represented by this sub public delegated prefix.
       "isAddress": True or False, # Whether the sub prefix is delegated to create Address resources in the delegatee project.
       "mode": "A String", # The PublicDelegatedSubPrefix mode for IPv6 only.
@@ -456,6 +460,7 @@ 
Method Details

       "byoipApiVersion": "A String", # [Output Only] The version of BYOIP API.
       "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.
+      "enableEnhancedIpv4Allocation": True or False, # [Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only.
       "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix.
       "id": "A String", # [Output Only] The unique identifier for the resource type. The server generates this identifier.
       "ipCidrRange": "A String", # The IP address range, in CIDR format, represented by this public delegated prefix.
@@ -469,6 +474,7 @@ 
Method Details

           "allocatablePrefixLength": 42, # The allocatable prefix length supported by this PublicDelegatedSubPrefix.
           "delegateeProject": "A String", # Name of the project scoping this PublicDelegatedSubPrefix.
           "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+          "enableEnhancedIpv4Allocation": True or False, # [Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only.
           "ipCidrRange": "A String", # The IP address range, in CIDR format, represented by this sub public delegated prefix.
           "isAddress": True or False, # Whether the sub prefix is delegated to create Address resources in the delegatee project.
           "mode": "A String", # The PublicDelegatedSubPrefix mode for IPv6 only.
@@ -527,6 +533,7 @@ 
Method Details

   "byoipApiVersion": "A String", # [Output Only] The version of BYOIP API.
   "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.
+  "enableEnhancedIpv4Allocation": True or False, # [Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only.
   "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix.
   "id": "A String", # [Output Only] The unique identifier for the resource type. The server generates this identifier.
   "ipCidrRange": "A String", # The IP address range, in CIDR format, represented by this public delegated prefix.
@@ -540,6 +547,7 @@ 
Method Details

       "allocatablePrefixLength": 42, # The allocatable prefix length supported by this PublicDelegatedSubPrefix.
       "delegateeProject": "A String", # Name of the project scoping this PublicDelegatedSubPrefix.
       "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+      "enableEnhancedIpv4Allocation": True or False, # [Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only.
       "ipCidrRange": "A String", # The IP address range, in CIDR format, represented by this sub public delegated prefix.
       "isAddress": True or False, # Whether the sub prefix is delegated to create Address resources in the delegatee project.
       "mode": "A String", # The PublicDelegatedSubPrefix mode for IPv6 only.
diff --git a/docs/dyn/compute_beta.html b/docs/dyn/compute_beta.html
index 60d96b79ea2..8bd9d87827f 100644
--- a/docs/dyn/compute_beta.html
+++ b/docs/dyn/compute_beta.html
@@ -404,6 +404,11 @@ 
Instance Methods

 

 
Returns the regionHealthChecks Resource.

 
+

+  regionHealthSources()
+

+
Returns the regionHealthSources Resource.

+
 

   regionInstanceGroupManagerResizeRequests()
 

@@ -449,6 +454,11 @@ 
Instance Methods

 

 
Returns the regionNetworkFirewallPolicies Resource.

 
+

+  regionNetworkPolicies()
+

+
Returns the regionNetworkPolicies Resource.

+
 

   regionNotificationEndpoints()
 

diff --git a/docs/dyn/compute_beta.imageFamilyViews.html b/docs/dyn/compute_beta.imageFamilyViews.html
index 763b6c875aa..e7232c72484 100644
--- a/docs/dyn/compute_beta.imageFamilyViews.html
+++ b/docs/dyn/compute_beta.imageFamilyViews.html
@@ -150,6 +150,11 @@ 
Method Details

     ],
     "locked": True or False, # A flag for marketplace VM disk created from the image, which is designed for marketplace VM disk to prevent the proprietary data on the disk from being accessed unwantedly. The flag will be inherited by the disk created from the image. The disk with locked flag set to true will be prohibited from performing the operations below: - R/W or R/O disk attach - Disk detach, if disk is created via create-on-create - Create images - Create snapshots - Create disk clone (create disk from the current disk) The image with the locked field set to true will be prohibited from performing the operations below: - Create images from the current image - Update the locked field for the current image The instance with at least one disk with locked flag set to true will be prohibited from performing the operations below: - Secondary disk attach - Create instant snapshot - Create machine images - Create instance template - Delete the instance with --keep-disk parameter set to true
     "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 with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+    "params": { # Additional image params. # Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.
+      "resourceManagerTags": { # Resource manager tags to be bound to the image. 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",
+      },
+    },
     "rawDisk": { # The parameters of the raw disk image.
       "containerType": "A String", # The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.
       "sha1Checksum": "A String", # [Deprecated] This field is deprecated. An optional SHA1 checksum of the disk image before unpackaging provided by the client when the disk image is created.
diff --git a/docs/dyn/compute_beta.images.html b/docs/dyn/compute_beta.images.html
index f9c61557068..3584d09bb46 100644
--- a/docs/dyn/compute_beta.images.html
+++ b/docs/dyn/compute_beta.images.html
@@ -446,6 +446,11 @@ 
Method Details

   ],
   "locked": True or False, # A flag for marketplace VM disk created from the image, which is designed for marketplace VM disk to prevent the proprietary data on the disk from being accessed unwantedly. The flag will be inherited by the disk created from the image. The disk with locked flag set to true will be prohibited from performing the operations below: - R/W or R/O disk attach - Disk detach, if disk is created via create-on-create - Create images - Create snapshots - Create disk clone (create disk from the current disk) The image with the locked field set to true will be prohibited from performing the operations below: - Create images from the current image - Update the locked field for the current image The instance with at least one disk with locked flag set to true will be prohibited from performing the operations below: - Secondary disk attach - Create instant snapshot - Create machine images - Create instance template - Delete the instance with --keep-disk parameter set to true
   "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 with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+  "params": { # Additional image params. # Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.
+    "resourceManagerTags": { # Resource manager tags to be bound to the image. 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",
+    },
+  },
   "rawDisk": { # The parameters of the raw disk image.
     "containerType": "A String", # The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.
     "sha1Checksum": "A String", # [Deprecated] This field is deprecated. An optional SHA1 checksum of the disk image before unpackaging provided by the client when the disk image is created.
@@ -584,6 +589,11 @@ 
Method Details

   ],
   "locked": True or False, # A flag for marketplace VM disk created from the image, which is designed for marketplace VM disk to prevent the proprietary data on the disk from being accessed unwantedly. The flag will be inherited by the disk created from the image. The disk with locked flag set to true will be prohibited from performing the operations below: - R/W or R/O disk attach - Disk detach, if disk is created via create-on-create - Create images - Create snapshots - Create disk clone (create disk from the current disk) The image with the locked field set to true will be prohibited from performing the operations below: - Create images from the current image - Update the locked field for the current image The instance with at least one disk with locked flag set to true will be prohibited from performing the operations below: - Secondary disk attach - Create instant snapshot - Create machine images - Create instance template - Delete the instance with --keep-disk parameter set to true
   "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 with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+  "params": { # Additional image params. # Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.
+    "resourceManagerTags": { # Resource manager tags to be bound to the image. 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",
+    },
+  },
   "rawDisk": { # The parameters of the raw disk image.
     "containerType": "A String", # The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.
     "sha1Checksum": "A String", # [Deprecated] This field is deprecated. An optional SHA1 checksum of the disk image before unpackaging provided by the client when the disk image is created.
@@ -765,6 +775,11 @@ 
Method Details

   ],
   "locked": True or False, # A flag for marketplace VM disk created from the image, which is designed for marketplace VM disk to prevent the proprietary data on the disk from being accessed unwantedly. The flag will be inherited by the disk created from the image. The disk with locked flag set to true will be prohibited from performing the operations below: - R/W or R/O disk attach - Disk detach, if disk is created via create-on-create - Create images - Create snapshots - Create disk clone (create disk from the current disk) The image with the locked field set to true will be prohibited from performing the operations below: - Create images from the current image - Update the locked field for the current image The instance with at least one disk with locked flag set to true will be prohibited from performing the operations below: - Secondary disk attach - Create instant snapshot - Create machine images - Create instance template - Delete the instance with --keep-disk parameter set to true
   "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 with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+  "params": { # Additional image params. # Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.
+    "resourceManagerTags": { # Resource manager tags to be bound to the image. 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",
+    },
+  },
   "rawDisk": { # The parameters of the raw disk image.
     "containerType": "A String", # The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.
     "sha1Checksum": "A String", # [Deprecated] This field is deprecated. An optional SHA1 checksum of the disk image before unpackaging provided by the client when the disk image is created.
@@ -1028,6 +1043,11 @@ 
Method Details

       ],
       "locked": True or False, # A flag for marketplace VM disk created from the image, which is designed for marketplace VM disk to prevent the proprietary data on the disk from being accessed unwantedly. The flag will be inherited by the disk created from the image. The disk with locked flag set to true will be prohibited from performing the operations below: - R/W or R/O disk attach - Disk detach, if disk is created via create-on-create - Create images - Create snapshots - Create disk clone (create disk from the current disk) The image with the locked field set to true will be prohibited from performing the operations below: - Create images from the current image - Update the locked field for the current image The instance with at least one disk with locked flag set to true will be prohibited from performing the operations below: - Secondary disk attach - Create instant snapshot - Create machine images - Create instance template - Delete the instance with --keep-disk parameter set to true
       "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 with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+      "params": { # Additional image params. # Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.
+        "resourceManagerTags": { # Resource manager tags to be bound to the image. 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",
+        },
+      },
       "rawDisk": { # The parameters of the raw disk image.
         "containerType": "A String", # The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.
         "sha1Checksum": "A String", # [Deprecated] This field is deprecated. An optional SHA1 checksum of the disk image before unpackaging provided by the client when the disk image is created.
@@ -1190,6 +1210,11 @@ 
Method Details

   ],
   "locked": True or False, # A flag for marketplace VM disk created from the image, which is designed for marketplace VM disk to prevent the proprietary data on the disk from being accessed unwantedly. The flag will be inherited by the disk created from the image. The disk with locked flag set to true will be prohibited from performing the operations below: - R/W or R/O disk attach - Disk detach, if disk is created via create-on-create - Create images - Create snapshots - Create disk clone (create disk from the current disk) The image with the locked field set to true will be prohibited from performing the operations below: - Create images from the current image - Update the locked field for the current image The instance with at least one disk with locked flag set to true will be prohibited from performing the operations below: - Secondary disk attach - Create instant snapshot - Create machine images - Create instance template - Delete the instance with --keep-disk parameter set to true
   "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 with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+  "params": { # Additional image params. # Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.
+    "resourceManagerTags": { # Resource manager tags to be bound to the image. 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",
+    },
+  },
   "rawDisk": { # The parameters of the raw disk image.
     "containerType": "A String", # The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.
     "sha1Checksum": "A String", # [Deprecated] This field is deprecated. An optional SHA1 checksum of the disk image before unpackaging provided by the client when the disk image is created.
diff --git a/docs/dyn/compute_beta.interconnects.html b/docs/dyn/compute_beta.interconnects.html
index 93185a9c37e..6f3a703396c 100644
--- a/docs/dyn/compute_beta.interconnects.html
+++ b/docs/dyn/compute_beta.interconnects.html
@@ -341,6 +341,7 @@ 
Method Details

   "satisfiesPzs": True or False, # [Output Only] Reserved for future use.
   "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
   "state": "A String", # [Output Only] The current state of Interconnect functionality, which can take one of the following values: - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect. - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect. - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.
+  "subzone": "A String", # Specific subzone in the InterconnectLocation that represents where this connection is to be provisioned.
   "wireGroups": [ # [Output Only] A list of the URLs of all CrossSiteNetwork WireGroups configured to use this Interconnect. The Interconnect cannot be deleted if this list is non-empty.
     "A String",
   ],
@@ -535,6 +536,7 @@ 
Method Details

   "satisfiesPzs": True or False, # [Output Only] Reserved for future use.
   "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
   "state": "A String", # [Output Only] The current state of Interconnect functionality, which can take one of the following values: - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect. - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect. - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.
+  "subzone": "A String", # Specific subzone in the InterconnectLocation that represents where this connection is to be provisioned.
   "wireGroups": [ # [Output Only] A list of the URLs of all CrossSiteNetwork WireGroups configured to use this Interconnect. The Interconnect cannot be deleted if this list is non-empty.
     "A String",
   ],
@@ -768,6 +770,7 @@ 
Method Details

       "satisfiesPzs": True or False, # [Output Only] Reserved for future use.
       "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
       "state": "A String", # [Output Only] The current state of Interconnect functionality, which can take one of the following values: - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect. - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect. - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.
+      "subzone": "A String", # Specific subzone in the InterconnectLocation that represents where this connection is to be provisioned.
       "wireGroups": [ # [Output Only] A list of the URLs of all CrossSiteNetwork WireGroups configured to use this Interconnect. The Interconnect cannot be deleted if this list is non-empty.
         "A String",
       ],
@@ -902,6 +905,7 @@ 
Method Details

   "satisfiesPzs": True or False, # [Output Only] Reserved for future use.
   "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
   "state": "A String", # [Output Only] The current state of Interconnect functionality, which can take one of the following values: - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect. - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect. - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.
+  "subzone": "A String", # Specific subzone in the InterconnectLocation that represents where this connection is to be provisioned.
   "wireGroups": [ # [Output Only] A list of the URLs of all CrossSiteNetwork WireGroups configured to use this Interconnect. The Interconnect cannot be deleted if this list is non-empty.
     "A String",
   ],
diff --git a/docs/dyn/compute_beta.publicDelegatedPrefixes.html b/docs/dyn/compute_beta.publicDelegatedPrefixes.html
index 820d125a888..6bd562933cc 100644
--- a/docs/dyn/compute_beta.publicDelegatedPrefixes.html
+++ b/docs/dyn/compute_beta.publicDelegatedPrefixes.html
@@ -139,6 +139,7 @@ 
Method Details

           "byoipApiVersion": "A String", # [Output Only] The version of BYOIP API.
           "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.
+          "enableEnhancedIpv4Allocation": True or False, # [Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only.
           "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix.
           "id": "A String", # [Output Only] The unique identifier for the resource type. The server generates this identifier.
           "ipCidrRange": "A String", # The IP address range, in CIDR format, represented by this public delegated prefix.
@@ -152,6 +153,7 @@ 
Method Details

               "allocatablePrefixLength": 42, # The allocatable prefix length supported by this PublicDelegatedSubPrefix.
               "delegateeProject": "A String", # Name of the project scoping this PublicDelegatedSubPrefix.
               "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+              "enableEnhancedIpv4Allocation": True or False, # [Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only.
               "ipCidrRange": "A String", # The IP address range, in CIDR format, represented by this sub public delegated prefix.
               "isAddress": True or False, # Whether the sub prefix is delegated to create Address resources in the delegatee project.
               "mode": "A String", # The PublicDelegatedSubPrefix mode for IPv6 only.
@@ -486,6 +488,7 @@ 
Method Details

   "byoipApiVersion": "A String", # [Output Only] The version of BYOIP API.
   "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.
+  "enableEnhancedIpv4Allocation": True or False, # [Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only.
   "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix.
   "id": "A String", # [Output Only] The unique identifier for the resource type. The server generates this identifier.
   "ipCidrRange": "A String", # The IP address range, in CIDR format, represented by this public delegated prefix.
@@ -499,6 +502,7 @@ 
Method Details

       "allocatablePrefixLength": 42, # The allocatable prefix length supported by this PublicDelegatedSubPrefix.
       "delegateeProject": "A String", # Name of the project scoping this PublicDelegatedSubPrefix.
       "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+      "enableEnhancedIpv4Allocation": True or False, # [Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only.
       "ipCidrRange": "A String", # The IP address range, in CIDR format, represented by this sub public delegated prefix.
       "isAddress": True or False, # Whether the sub prefix is delegated to create Address resources in the delegatee project.
       "mode": "A String", # The PublicDelegatedSubPrefix mode for IPv6 only.
@@ -528,6 +532,7 @@ 
Method Details

   "byoipApiVersion": "A String", # [Output Only] The version of BYOIP API.
   "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.
+  "enableEnhancedIpv4Allocation": True or False, # [Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only.
   "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix.
   "id": "A String", # [Output Only] The unique identifier for the resource type. The server generates this identifier.
   "ipCidrRange": "A String", # The IP address range, in CIDR format, represented by this public delegated prefix.
@@ -541,6 +546,7 @@ 
Method Details

       "allocatablePrefixLength": 42, # The allocatable prefix length supported by this PublicDelegatedSubPrefix.
       "delegateeProject": "A String", # Name of the project scoping this PublicDelegatedSubPrefix.
       "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+      "enableEnhancedIpv4Allocation": True or False, # [Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only.
       "ipCidrRange": "A String", # The IP address range, in CIDR format, represented by this sub public delegated prefix.
       "isAddress": True or False, # Whether the sub prefix is delegated to create Address resources in the delegatee project.
       "mode": "A String", # The PublicDelegatedSubPrefix mode for IPv6 only.
@@ -699,6 +705,7 @@ 
Method Details

       "byoipApiVersion": "A String", # [Output Only] The version of BYOIP API.
       "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.
+      "enableEnhancedIpv4Allocation": True or False, # [Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only.
       "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix.
       "id": "A String", # [Output Only] The unique identifier for the resource type. The server generates this identifier.
       "ipCidrRange": "A String", # The IP address range, in CIDR format, represented by this public delegated prefix.
@@ -712,6 +719,7 @@ 
Method Details

           "allocatablePrefixLength": 42, # The allocatable prefix length supported by this PublicDelegatedSubPrefix.
           "delegateeProject": "A String", # Name of the project scoping this PublicDelegatedSubPrefix.
           "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+          "enableEnhancedIpv4Allocation": True or False, # [Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only.
           "ipCidrRange": "A String", # The IP address range, in CIDR format, represented by this sub public delegated prefix.
           "isAddress": True or False, # Whether the sub prefix is delegated to create Address resources in the delegatee project.
           "mode": "A String", # The PublicDelegatedSubPrefix mode for IPv6 only.
@@ -771,6 +779,7 @@ 
Method Details

   "byoipApiVersion": "A String", # [Output Only] The version of BYOIP API.
   "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.
+  "enableEnhancedIpv4Allocation": True or False, # [Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only.
   "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix.
   "id": "A String", # [Output Only] The unique identifier for the resource type. The server generates this identifier.
   "ipCidrRange": "A String", # The IP address range, in CIDR format, represented by this public delegated prefix.
@@ -784,6 +793,7 @@ 
Method Details

       "allocatablePrefixLength": 42, # The allocatable prefix length supported by this PublicDelegatedSubPrefix.
       "delegateeProject": "A String", # Name of the project scoping this PublicDelegatedSubPrefix.
       "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+      "enableEnhancedIpv4Allocation": True or False, # [Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only.
       "ipCidrRange": "A String", # The IP address range, in CIDR format, represented by this sub public delegated prefix.
       "isAddress": True or False, # Whether the sub prefix is delegated to create Address resources in the delegatee project.
       "mode": "A String", # The PublicDelegatedSubPrefix mode for IPv6 only.
diff --git a/docs/dyn/compute_beta.regionDisks.html b/docs/dyn/compute_beta.regionDisks.html
index 5a12b2240c6..aaf24732894 100644
--- a/docs/dyn/compute_beta.regionDisks.html
+++ b/docs/dyn/compute_beta.regionDisks.html
@@ -413,7 +413,7 @@ 
Method Details

   body: object, The request body.
     The object takes the form of:
 
-{ # Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. LINT.IfChange
+{ # Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots.
   "architecture": "A String", # [Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64.
   "autoCreated": True or False, # [Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk.
   "chainName": "A String", # Creates the new snapshot in the snapshot chain labeled with the specified name. The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value.
@@ -443,6 +443,11 @@ 
Method Details

   ],
   "locationHint": "A String", # An opaque location hint used to place the snapshot close to other resources. This field is for use by internal tools that use the public API.
   "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 with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+  "params": { # Additional snapshot params. # Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.
+    "resourceManagerTags": { # Resource manager tags to be bound to the snapshot. 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",
+    },
+  },
   "region": "A String", # [Output Only] URL of the region where the snapshot resides. Only applicable for regional snapshots.
   "satisfiesPzi": True or False, # Output only. Reserved for future use.
   "satisfiesPzs": True or False, # [Output Only] Reserved for future use.
diff --git a/docs/dyn/compute_beta.regionHealthSources.html b/docs/dyn/compute_beta.regionHealthSources.html
new file mode 100644
index 00000000000..dc259a6f5fa
--- /dev/null
+++ b/docs/dyn/compute_beta.regionHealthSources.html
@@ -0,0 +1,748 @@
+
+
+
+
Compute Engine API . regionHealthSources

+
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 HealthSource resources (all regional) available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.

+

+  aggregatedList_next()

+
Retrieves the next page of results.

+

+  close()

+
Close httplib2 connections.

+

+  delete(project, region, healthSource, requestId=None, x__xgafv=None)

+
Deletes the specified HealthSource in the given region

+

+  get(project, region, healthSource, x__xgafv=None)

+
Returns the specified HealthSource resource in the given region.

+

+  insert(project, region, body=None, requestId=None, x__xgafv=None)

+
Create a HealthSource in the specified project in the given region using the parameters that are included in the request.

+

+  list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+
Lists the HealthSources for a project in the given region.

+

+  list_next()

+
Retrieves the next page of results.

+

+  patch(project, region, healthSource, body=None, requestId=None, x__xgafv=None)

+
Updates the specified regional HealthSource resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

+

+  testIamPermissions(project, region, resource, body=None, x__xgafv=None)

+
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)
+  
Retrieves the list of all HealthSource resources (all regional) available to the specified project. To prevent failure, Google recommends 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 on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
+  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:
+
+    { # Contains a list of HealthSourcesScopedList.
+  "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+  "items": { # A list of HealthSourcesScopedList resources.
+    "a_key": { # Name of the scope containing this set of HealthSources.
+      "healthSources": [ # A list of HealthSources contained in this scope.
+        { # Represents a health source. A health source resource specifies the source resources and the health aggregation policy applied to the source resources to determine the aggregated health status.
+          "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.
+          "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a HealthSource. An up-to-date fingerprint must be provided in order to patch the HealthSource; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthSource.
+          "healthAggregationPolicy": "A String", # URL to the HealthAggregationPolicy resource. Must be set. Must be regional and in the same region as the HealthSource. Can be mutated.
+          "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
+          "kind": "compute#healthSource", # [Output Only] Type of the resource. Always compute#healthSource for health sources.
+          "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 with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+          "region": "A String", # [Output Only] URL of the region where the health source resides. This field applies only to the regional resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+          "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+          "selfLinkWithId": "A String", # [Output Only] Server-defined URL with id for the resource.
+          "sourceType": "A String", # Specifies the type of the HealthSource. The only allowed value is BACKEND_SERVICE. Must be specified when the HealthSource is created, and cannot be mutated.
+          "sources": [ # URLs to the source resources. Must be size 1. Must be a BackendService if the sourceType is BACKEND_SERVICE. The BackendService must have load balancing scheme INTERNAL or INTERNAL_MANAGED and must be regional and in the same region as the HealthSource (cross-region deployment for INTERNAL_MANAGED is not supported). The BackendService may use only IGs, MIGs, or NEGs of type GCE_VM_IP or GCE_VM_IP_PORT. The BackendService may not use haPolicy. Can be mutated.
+            "A String",
+          ],
+        },
+      ],
+      "warning": { # Informational warning which replaces the list of health sources 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#healthSourceAggregatedList", # 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 than maxResults, use the nextPageToken as a value 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.
+  "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.

+

+
+

+    delete(project, region, healthSource, requestId=None, x__xgafv=None)
+  
Deletes the specified HealthSource in the given region
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region scoping this request. (required)
+  healthSource: string, Name of the HealthSource 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/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, read Handling 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 in RFC3339 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 in RFC3339 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 different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be 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 in RFC3339 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, region, healthSource, x__xgafv=None)
+  
Returns the specified HealthSource resource in the given region.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region scoping this request. (required)
+  healthSource: string, Name of the HealthSource 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 health source. A health source resource specifies the source resources and the health aggregation policy applied to the source resources to determine the aggregated health status.
+  "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.
+  "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a HealthSource. An up-to-date fingerprint must be provided in order to patch the HealthSource; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthSource.
+  "healthAggregationPolicy": "A String", # URL to the HealthAggregationPolicy resource. Must be set. Must be regional and in the same region as the HealthSource. Can be mutated.
+  "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
+  "kind": "compute#healthSource", # [Output Only] Type of the resource. Always compute#healthSource for health sources.
+  "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 with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+  "region": "A String", # [Output Only] URL of the region where the health source resides. This field applies only to the regional resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL with id for the resource.
+  "sourceType": "A String", # Specifies the type of the HealthSource. The only allowed value is BACKEND_SERVICE. Must be specified when the HealthSource is created, and cannot be mutated.
+  "sources": [ # URLs to the source resources. Must be size 1. Must be a BackendService if the sourceType is BACKEND_SERVICE. The BackendService must have load balancing scheme INTERNAL or INTERNAL_MANAGED and must be regional and in the same region as the HealthSource (cross-region deployment for INTERNAL_MANAGED is not supported). The BackendService may use only IGs, MIGs, or NEGs of type GCE_VM_IP or GCE_VM_IP_PORT. The BackendService may not use haPolicy. Can be mutated.
+    "A String",
+  ],
+}

+

+
+

+    insert(project, region, body=None, requestId=None, x__xgafv=None)
+  
Create a HealthSource in the specified project in the given region using the parameters that are included in the request.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region scoping this request. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a health source. A health source resource specifies the source resources and the health aggregation policy applied to the source resources to determine the aggregated health status.
+  "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.
+  "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a HealthSource. An up-to-date fingerprint must be provided in order to patch the HealthSource; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthSource.
+  "healthAggregationPolicy": "A String", # URL to the HealthAggregationPolicy resource. Must be set. Must be regional and in the same region as the HealthSource. Can be mutated.
+  "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
+  "kind": "compute#healthSource", # [Output Only] Type of the resource. Always compute#healthSource for health sources.
+  "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 with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+  "region": "A String", # [Output Only] URL of the region where the health source resides. This field applies only to the regional resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL with id for the resource.
+  "sourceType": "A String", # Specifies the type of the HealthSource. The only allowed value is BACKEND_SERVICE. Must be specified when the HealthSource is created, and cannot be mutated.
+  "sources": [ # URLs to the source resources. Must be size 1. Must be a BackendService if the sourceType is BACKEND_SERVICE. The BackendService must have load balancing scheme INTERNAL or INTERNAL_MANAGED and must be regional and in the same region as the HealthSource (cross-region deployment for INTERNAL_MANAGED is not supported). The BackendService may use only IGs, MIGs, or NEGs of type GCE_VM_IP or GCE_VM_IP_PORT. The BackendService may not use haPolicy. Can be mutated.
+    "A String",
+  ],
+}
+
+  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, read Handling 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 in RFC3339 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 in RFC3339 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 different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be 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 in RFC3339 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, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
+  
Lists the HealthSources for a project in the given region.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region 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 on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
+  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:
+
+    {
+  "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+  "items": [ # A list of HealthSource resources.
+    { # Represents a health source. A health source resource specifies the source resources and the health aggregation policy applied to the source resources to determine the aggregated health status.
+      "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.
+      "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a HealthSource. An up-to-date fingerprint must be provided in order to patch the HealthSource; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthSource.
+      "healthAggregationPolicy": "A String", # URL to the HealthAggregationPolicy resource. Must be set. Must be regional and in the same region as the HealthSource. Can be mutated.
+      "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
+      "kind": "compute#healthSource", # [Output Only] Type of the resource. Always compute#healthSource for health sources.
+      "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 with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+      "region": "A String", # [Output Only] URL of the region where the health source resides. This field applies only to the regional resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+      "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+      "selfLinkWithId": "A String", # [Output Only] Server-defined URL with id for the resource.
+      "sourceType": "A String", # Specifies the type of the HealthSource. The only allowed value is BACKEND_SERVICE. Must be specified when the HealthSource is created, and cannot be mutated.
+      "sources": [ # URLs to the source resources. Must be size 1. Must be a BackendService if the sourceType is BACKEND_SERVICE. The BackendService must have load balancing scheme INTERNAL or INTERNAL_MANAGED and must be regional and in the same region as the HealthSource (cross-region deployment for INTERNAL_MANAGED is not supported). The BackendService may use only IGs, MIGs, or NEGs of type GCE_VM_IP or GCE_VM_IP_PORT. The BackendService may not use haPolicy. Can be mutated.
+        "A String",
+      ],
+    },
+  ],
+  "kind": "compute#healthSourceList", # [Output Only] Type of the resource. Always compute#healthSource for health sources.
+  "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 than maxResults, use the nextPageToken as a value 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.
+  "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.
+        

+

+
+

+    patch(project, region, healthSource, body=None, requestId=None, x__xgafv=None)
+  
Updates the specified regional HealthSource resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region scoping this request. (required)
+  healthSource: string, Name of the HealthSource to update. The name must be 1-63 characters long, and comply with RFC1035. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a health source. A health source resource specifies the source resources and the health aggregation policy applied to the source resources to determine the aggregated health status.
+  "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.
+  "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a HealthSource. An up-to-date fingerprint must be provided in order to patch the HealthSource; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthSource.
+  "healthAggregationPolicy": "A String", # URL to the HealthAggregationPolicy resource. Must be set. Must be regional and in the same region as the HealthSource. Can be mutated.
+  "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
+  "kind": "compute#healthSource", # [Output Only] Type of the resource. Always compute#healthSource for health sources.
+  "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 with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+  "region": "A String", # [Output Only] URL of the region where the health source resides. This field applies only to the regional resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL with id for the resource.
+  "sourceType": "A String", # Specifies the type of the HealthSource. The only allowed value is BACKEND_SERVICE. Must be specified when the HealthSource is created, and cannot be mutated.
+  "sources": [ # URLs to the source resources. Must be size 1. Must be a BackendService if the sourceType is BACKEND_SERVICE. The BackendService must have load balancing scheme INTERNAL or INTERNAL_MANAGED and must be regional and in the same region as the HealthSource (cross-region deployment for INTERNAL_MANAGED is not supported). The BackendService may use only IGs, MIGs, or NEGs of type GCE_VM_IP or GCE_VM_IP_PORT. The BackendService may not use haPolicy. Can be mutated.
+    "A String",
+  ],
+}
+
+  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, read Handling 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 in RFC3339 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 in RFC3339 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 different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be 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 in RFC3339 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.
+}

+

+
+

+    testIamPermissions(project, region, 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)
+  region: string, The name of the region 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",
+  ],
+}

+

+
+
\ No newline at end of file
diff --git a/docs/dyn/compute_beta.regionNetworkPolicies.html b/docs/dyn/compute_beta.regionNetworkPolicies.html
new file mode 100644
index 00000000000..653ef3c7799
--- /dev/null
+++ b/docs/dyn/compute_beta.regionNetworkPolicies.html
@@ -0,0 +1,1749 @@
+
+
+
+
Compute Engine API . regionNetworkPolicies

+
Instance Methods

+

+  addAssociation(project, region, networkPolicy, body=None, requestId=None, x__xgafv=None)

+
Inserts an association for the specified network policy.

+

+  addTrafficClassificationRule(project, region, networkPolicy, body=None, requestId=None, x__xgafv=None)

+
Inserts a rule into a network policy.

+

+  aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)

+
Retrieves an aggregated list of network policies. To prevent failure, it's recommended that you set the `returnPartialSuccess` parameter to `true`.

+

+  aggregatedList_next()

+
Retrieves the next page of results.

+

+  close()

+
Close httplib2 connections.

+

+  delete(project, region, networkPolicy, requestId=None, x__xgafv=None)

+
Deletes the specified policy.

+

+  get(project, region, networkPolicy, x__xgafv=None)

+
Returns the specified network policy.

+

+  getAssociation(project, region, networkPolicy, name=None, x__xgafv=None)

+
Gets an association with the specified name.

+

+  getTrafficClassificationRule(project, region, networkPolicy, priority=None, x__xgafv=None)

+
Gets a rule of the specified priority.

+

+  insert(project, region, body=None, requestId=None, x__xgafv=None)

+
Creates a new policy in the specified project using the data included in the request.

+

+  list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+
Lists all the policies that have been configured for the specified project in the given region.

+

+  list_next()

+
Retrieves the next page of results.

+

+  patch(project, region, networkPolicy, body=None, requestId=None, x__xgafv=None)

+
Patches the specified policy with the data included in the request.

+

+  patchTrafficClassificationRule(project, region, networkPolicy, body=None, priority=None, requestId=None, x__xgafv=None)

+
Patches a rule of the specified priority.

+

+  removeAssociation(project, region, networkPolicy, name=None, requestId=None, x__xgafv=None)

+
Removes an association for the specified network policy.

+

+  removeTrafficClassificationRule(project, region, networkPolicy, priority=None, requestId=None, x__xgafv=None)

+
Deletes a rule of the specified priority.

+
Method Details

+

+    addAssociation(project, region, networkPolicy, body=None, requestId=None, x__xgafv=None)
+  
Inserts an association for the specified network policy.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region of this request. (required)
+  networkPolicy: string, Name of the network policy resource to update. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "attachmentTarget": "A String", # The target that the network policy is attached to.
+  "name": "A String", # The name for an association.
+}
+
+  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, read Handling 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 in RFC3339 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 in RFC3339 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 different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be 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 in RFC3339 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.
+}

+

+
+

+    addTrafficClassificationRule(project, region, networkPolicy, body=None, requestId=None, x__xgafv=None)
+  
Inserts a rule into a network policy.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region of this request. (required)
+  networkPolicy: string, Name of the network policy resource to update. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a traffic classification rule that describes one or more match conditions along with the action to be taken when traffic matches this condition.
+  "action": { # The Action to perform when the client connection triggers the rule.
+    "dscpMode": "A String", # The traffic class that should be applied to the matching packet.
+    "dscpValue": 42, # Custom DSCP value from 0-63 range.
+    "trafficClass": "A String", # The traffic class that should be applied to the matching packet.
+    "type": "A String", # Always "apply_traffic_classification" for traffic classification rules.
+  },
+  "description": "A String", # An optional description for this resource.
+  "disabled": True or False, # Denotes whether the network policy rule is disabled. When set to true, the network policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the network policy rule will be enabled.
+  "kind": "compute#networkPolicyTrafficClassificationRule", # [Output only] Type of the resource. Always compute#networkPolicyTrafficClassificationRule for network policy traffic classification rules
+  "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that outgoing traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
+    "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000.
+      "A String",
+    ],
+    "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.
+      {
+        "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a traffic classification rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.
+        "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
+          "A String",
+        ],
+      },
+    ],
+    "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000.
+      "A String",
+    ],
+  },
+  "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 1 and 2147482647. The priority values from 2147482648 to 2147483647 (1000) are reserved for system default network policy rules. Rules are evaluated from highest to lowest priority where 1 is the highest priority and 2147483647 is the lowest priority.
+  "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated.
+  "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single network policy rule.
+  "targetSecureTags": [ # A list of secure tags that controls which instances the traffic classification rule applies to. If targetSecureTag are specified, then the traffic classification rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the targetSecureTag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the traffic classification rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.
+    {
+      "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
+      "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
+    },
+  ],
+  "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.
+    "A String",
+  ],
+}
+
+  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, read Handling 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 in RFC3339 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 in RFC3339 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 different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be 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 in RFC3339 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.
+}

+

+
+

+    aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)
+  
Retrieves an aggregated list of network policies. To prevent failure, it's recommended that you set the `returnPartialSuccess` parameter to `true`.
+
+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 on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
+  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:
+
+    {
+  "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+  "items": { # A list of NetworkPoliciesScopedList resources.
+    "a_key": { # Name of the scope containing this set of addresses.
+      "networkPolicies": [ # A list of network policies contained in this scope.
+        { # Represents a Network Policy resource.
+          "associations": [ # [Output Only] A list of associations that belong to this network policy.
+            {
+              "attachmentTarget": "A String", # The target that the network policy is attached to.
+              "name": "A String", # The name for an association.
+            },
+          ],
+          "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.
+          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+          "kind": "compute#networkPolicy", # [Output only] Type of the resource. Always compute#networkPolicy for network policies
+          "name": "A String", # Name of the resource.
+          "region": "A String", # [Output Only] URL of the region where the regional network policy resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+          "ruleTupleCount": 42, # [Output Only] Total count of all network policy rule tuples. A network policy can not exceed a set number of tuples.
+          "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.
+          "trafficClassificationRules": [ # [Output Only] A list of traffic classification rules that belong to this policy.
+            { # Represents a traffic classification rule that describes one or more match conditions along with the action to be taken when traffic matches this condition.
+              "action": { # The Action to perform when the client connection triggers the rule.
+                "dscpMode": "A String", # The traffic class that should be applied to the matching packet.
+                "dscpValue": 42, # Custom DSCP value from 0-63 range.
+                "trafficClass": "A String", # The traffic class that should be applied to the matching packet.
+                "type": "A String", # Always "apply_traffic_classification" for traffic classification rules.
+              },
+              "description": "A String", # An optional description for this resource.
+              "disabled": True or False, # Denotes whether the network policy rule is disabled. When set to true, the network policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the network policy rule will be enabled.
+              "kind": "compute#networkPolicyTrafficClassificationRule", # [Output only] Type of the resource. Always compute#networkPolicyTrafficClassificationRule for network policy traffic classification rules
+              "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that outgoing traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
+                "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000.
+                  "A String",
+                ],
+                "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.
+                  {
+                    "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a traffic classification rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.
+                    "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
+                      "A String",
+                    ],
+                  },
+                ],
+                "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000.
+                  "A String",
+                ],
+              },
+              "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 1 and 2147482647. The priority values from 2147482648 to 2147483647 (1000) are reserved for system default network policy rules. Rules are evaluated from highest to lowest priority where 1 is the highest priority and 2147483647 is the lowest priority.
+              "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated.
+              "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single network policy rule.
+              "targetSecureTags": [ # A list of secure tags that controls which instances the traffic classification rule applies to. If targetSecureTag are specified, then the traffic classification rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the targetSecureTag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the traffic classification rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.
+                {
+                  "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
+                  "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
+                },
+              ],
+              "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.
+                "A String",
+              ],
+            },
+          ],
+        },
+      ],
+      "warning": { # Informational warning which replaces the list of network policies 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#networkPolicyAggregatedList", # [Output Only] Type of resource. Always compute#networkPolicyAggregatedList for lists of network policies.
+  "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 than maxResults, use the nextPageToken as a value 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.

+

+
+

+    delete(project, region, networkPolicy, requestId=None, x__xgafv=None)
+  
Deletes the specified policy.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region of this request. (required)
+  networkPolicy: string, Name of the network policy 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/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, read Handling 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 in RFC3339 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 in RFC3339 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 different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be 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 in RFC3339 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, region, networkPolicy, x__xgafv=None)
+  
Returns the specified network policy.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region of this request. (required)
+  networkPolicy: string, Name of the network 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 Network Policy resource.
+  "associations": [ # [Output Only] A list of associations that belong to this network policy.
+    {
+      "attachmentTarget": "A String", # The target that the network policy is attached to.
+      "name": "A String", # The name for an association.
+    },
+  ],
+  "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.
+  "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+  "kind": "compute#networkPolicy", # [Output only] Type of the resource. Always compute#networkPolicy for network policies
+  "name": "A String", # Name of the resource.
+  "region": "A String", # [Output Only] URL of the region where the regional network policy resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+  "ruleTupleCount": 42, # [Output Only] Total count of all network policy rule tuples. A network policy can not exceed a set number of tuples.
+  "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.
+  "trafficClassificationRules": [ # [Output Only] A list of traffic classification rules that belong to this policy.
+    { # Represents a traffic classification rule that describes one or more match conditions along with the action to be taken when traffic matches this condition.
+      "action": { # The Action to perform when the client connection triggers the rule.
+        "dscpMode": "A String", # The traffic class that should be applied to the matching packet.
+        "dscpValue": 42, # Custom DSCP value from 0-63 range.
+        "trafficClass": "A String", # The traffic class that should be applied to the matching packet.
+        "type": "A String", # Always "apply_traffic_classification" for traffic classification rules.
+      },
+      "description": "A String", # An optional description for this resource.
+      "disabled": True or False, # Denotes whether the network policy rule is disabled. When set to true, the network policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the network policy rule will be enabled.
+      "kind": "compute#networkPolicyTrafficClassificationRule", # [Output only] Type of the resource. Always compute#networkPolicyTrafficClassificationRule for network policy traffic classification rules
+      "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that outgoing traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
+        "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000.
+          "A String",
+        ],
+        "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.
+          {
+            "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a traffic classification rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.
+            "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
+              "A String",
+            ],
+          },
+        ],
+        "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000.
+          "A String",
+        ],
+      },
+      "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 1 and 2147482647. The priority values from 2147482648 to 2147483647 (1000) are reserved for system default network policy rules. Rules are evaluated from highest to lowest priority where 1 is the highest priority and 2147483647 is the lowest priority.
+      "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated.
+      "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single network policy rule.
+      "targetSecureTags": [ # A list of secure tags that controls which instances the traffic classification rule applies to. If targetSecureTag are specified, then the traffic classification rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the targetSecureTag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the traffic classification rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.
+        {
+          "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
+          "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
+        },
+      ],
+      "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.
+        "A String",
+      ],
+    },
+  ],
+}

+

+
+

+    getAssociation(project, region, networkPolicy, name=None, x__xgafv=None)
+  
Gets an association with the specified name.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region of this request. (required)
+  networkPolicy: string, Name of the network policy to which the queried association belongs. (required)
+  name: string, The name of the association to get from the network policy.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "attachmentTarget": "A String", # The target that the network policy is attached to.
+  "name": "A String", # The name for an association.
+}

+

+
+

+    getTrafficClassificationRule(project, region, networkPolicy, priority=None, x__xgafv=None)
+  
Gets a rule of the specified priority.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region of this request. (required)
+  networkPolicy: string, Name of the network policy to which the queried rule belongs. (required)
+  priority: integer, The priority of the rule to get from the network policy.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a traffic classification rule that describes one or more match conditions along with the action to be taken when traffic matches this condition.
+  "action": { # The Action to perform when the client connection triggers the rule.
+    "dscpMode": "A String", # The traffic class that should be applied to the matching packet.
+    "dscpValue": 42, # Custom DSCP value from 0-63 range.
+    "trafficClass": "A String", # The traffic class that should be applied to the matching packet.
+    "type": "A String", # Always "apply_traffic_classification" for traffic classification rules.
+  },
+  "description": "A String", # An optional description for this resource.
+  "disabled": True or False, # Denotes whether the network policy rule is disabled. When set to true, the network policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the network policy rule will be enabled.
+  "kind": "compute#networkPolicyTrafficClassificationRule", # [Output only] Type of the resource. Always compute#networkPolicyTrafficClassificationRule for network policy traffic classification rules
+  "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that outgoing traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
+    "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000.
+      "A String",
+    ],
+    "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.
+      {
+        "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a traffic classification rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.
+        "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
+          "A String",
+        ],
+      },
+    ],
+    "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000.
+      "A String",
+    ],
+  },
+  "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 1 and 2147482647. The priority values from 2147482648 to 2147483647 (1000) are reserved for system default network policy rules. Rules are evaluated from highest to lowest priority where 1 is the highest priority and 2147483647 is the lowest priority.
+  "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated.
+  "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single network policy rule.
+  "targetSecureTags": [ # A list of secure tags that controls which instances the traffic classification rule applies to. If targetSecureTag are specified, then the traffic classification rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the targetSecureTag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the traffic classification rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.
+    {
+      "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
+      "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
+    },
+  ],
+  "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.
+    "A String",
+  ],
+}

+

+
+

+    insert(project, region, body=None, requestId=None, x__xgafv=None)
+  
Creates a new policy in the specified project using the data included in the request.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region of this request. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a Network Policy resource.
+  "associations": [ # [Output Only] A list of associations that belong to this network policy.
+    {
+      "attachmentTarget": "A String", # The target that the network policy is attached to.
+      "name": "A String", # The name for an association.
+    },
+  ],
+  "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.
+  "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+  "kind": "compute#networkPolicy", # [Output only] Type of the resource. Always compute#networkPolicy for network policies
+  "name": "A String", # Name of the resource.
+  "region": "A String", # [Output Only] URL of the region where the regional network policy resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+  "ruleTupleCount": 42, # [Output Only] Total count of all network policy rule tuples. A network policy can not exceed a set number of tuples.
+  "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.
+  "trafficClassificationRules": [ # [Output Only] A list of traffic classification rules that belong to this policy.
+    { # Represents a traffic classification rule that describes one or more match conditions along with the action to be taken when traffic matches this condition.
+      "action": { # The Action to perform when the client connection triggers the rule.
+        "dscpMode": "A String", # The traffic class that should be applied to the matching packet.
+        "dscpValue": 42, # Custom DSCP value from 0-63 range.
+        "trafficClass": "A String", # The traffic class that should be applied to the matching packet.
+        "type": "A String", # Always "apply_traffic_classification" for traffic classification rules.
+      },
+      "description": "A String", # An optional description for this resource.
+      "disabled": True or False, # Denotes whether the network policy rule is disabled. When set to true, the network policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the network policy rule will be enabled.
+      "kind": "compute#networkPolicyTrafficClassificationRule", # [Output only] Type of the resource. Always compute#networkPolicyTrafficClassificationRule for network policy traffic classification rules
+      "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that outgoing traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
+        "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000.
+          "A String",
+        ],
+        "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.
+          {
+            "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a traffic classification rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.
+            "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
+              "A String",
+            ],
+          },
+        ],
+        "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000.
+          "A String",
+        ],
+      },
+      "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 1 and 2147482647. The priority values from 2147482648 to 2147483647 (1000) are reserved for system default network policy rules. Rules are evaluated from highest to lowest priority where 1 is the highest priority and 2147483647 is the lowest priority.
+      "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated.
+      "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single network policy rule.
+      "targetSecureTags": [ # A list of secure tags that controls which instances the traffic classification rule applies to. If targetSecureTag are specified, then the traffic classification rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the targetSecureTag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the traffic classification rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.
+        {
+          "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
+          "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
+        },
+      ],
+      "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.
+        "A String",
+      ],
+    },
+  ],
+}
+
+  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, read Handling 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 in RFC3339 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 in RFC3339 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 different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be 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 in RFC3339 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, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
+  
Lists all the policies that have been configured for the specified project in the given region.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region of 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 on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
+  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:
+
+    {
+  "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+  "items": [ # A list of NetworkPolicy resources.
+    { # Represents a Network Policy resource.
+      "associations": [ # [Output Only] A list of associations that belong to this network policy.
+        {
+          "attachmentTarget": "A String", # The target that the network policy is attached to.
+          "name": "A String", # The name for an association.
+        },
+      ],
+      "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.
+      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+      "kind": "compute#networkPolicy", # [Output only] Type of the resource. Always compute#networkPolicy for network policies
+      "name": "A String", # Name of the resource.
+      "region": "A String", # [Output Only] URL of the region where the regional network policy resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+      "ruleTupleCount": 42, # [Output Only] Total count of all network policy rule tuples. A network policy can not exceed a set number of tuples.
+      "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.
+      "trafficClassificationRules": [ # [Output Only] A list of traffic classification rules that belong to this policy.
+        { # Represents a traffic classification rule that describes one or more match conditions along with the action to be taken when traffic matches this condition.
+          "action": { # The Action to perform when the client connection triggers the rule.
+            "dscpMode": "A String", # The traffic class that should be applied to the matching packet.
+            "dscpValue": 42, # Custom DSCP value from 0-63 range.
+            "trafficClass": "A String", # The traffic class that should be applied to the matching packet.
+            "type": "A String", # Always "apply_traffic_classification" for traffic classification rules.
+          },
+          "description": "A String", # An optional description for this resource.
+          "disabled": True or False, # Denotes whether the network policy rule is disabled. When set to true, the network policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the network policy rule will be enabled.
+          "kind": "compute#networkPolicyTrafficClassificationRule", # [Output only] Type of the resource. Always compute#networkPolicyTrafficClassificationRule for network policy traffic classification rules
+          "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that outgoing traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
+            "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000.
+              "A String",
+            ],
+            "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.
+              {
+                "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a traffic classification rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.
+                "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
+                  "A String",
+                ],
+              },
+            ],
+            "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000.
+              "A String",
+            ],
+          },
+          "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 1 and 2147482647. The priority values from 2147482648 to 2147483647 (1000) are reserved for system default network policy rules. Rules are evaluated from highest to lowest priority where 1 is the highest priority and 2147483647 is the lowest priority.
+          "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated.
+          "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single network policy rule.
+          "targetSecureTags": [ # A list of secure tags that controls which instances the traffic classification rule applies to. If targetSecureTag are specified, then the traffic classification rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the targetSecureTag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the traffic classification rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.
+            {
+              "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
+              "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
+            },
+          ],
+          "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.
+            "A String",
+          ],
+        },
+      ],
+    },
+  ],
+  "kind": "compute#networkPolicyList", # [Output Only] Type of resource. Always compute#networkPolicyList for lists of network policies.
+  "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 than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+  "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.
+        

+

+
+

+    patch(project, region, networkPolicy, body=None, requestId=None, x__xgafv=None)
+  
Patches the specified policy with the data included in the request.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region of this request. (required)
+  networkPolicy: string, Name of the network policy resource to update. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a Network Policy resource.
+  "associations": [ # [Output Only] A list of associations that belong to this network policy.
+    {
+      "attachmentTarget": "A String", # The target that the network policy is attached to.
+      "name": "A String", # The name for an association.
+    },
+  ],
+  "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.
+  "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+  "kind": "compute#networkPolicy", # [Output only] Type of the resource. Always compute#networkPolicy for network policies
+  "name": "A String", # Name of the resource.
+  "region": "A String", # [Output Only] URL of the region where the regional network policy resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+  "ruleTupleCount": 42, # [Output Only] Total count of all network policy rule tuples. A network policy can not exceed a set number of tuples.
+  "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.
+  "trafficClassificationRules": [ # [Output Only] A list of traffic classification rules that belong to this policy.
+    { # Represents a traffic classification rule that describes one or more match conditions along with the action to be taken when traffic matches this condition.
+      "action": { # The Action to perform when the client connection triggers the rule.
+        "dscpMode": "A String", # The traffic class that should be applied to the matching packet.
+        "dscpValue": 42, # Custom DSCP value from 0-63 range.
+        "trafficClass": "A String", # The traffic class that should be applied to the matching packet.
+        "type": "A String", # Always "apply_traffic_classification" for traffic classification rules.
+      },
+      "description": "A String", # An optional description for this resource.
+      "disabled": True or False, # Denotes whether the network policy rule is disabled. When set to true, the network policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the network policy rule will be enabled.
+      "kind": "compute#networkPolicyTrafficClassificationRule", # [Output only] Type of the resource. Always compute#networkPolicyTrafficClassificationRule for network policy traffic classification rules
+      "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that outgoing traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
+        "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000.
+          "A String",
+        ],
+        "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.
+          {
+            "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a traffic classification rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.
+            "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
+              "A String",
+            ],
+          },
+        ],
+        "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000.
+          "A String",
+        ],
+      },
+      "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 1 and 2147482647. The priority values from 2147482648 to 2147483647 (1000) are reserved for system default network policy rules. Rules are evaluated from highest to lowest priority where 1 is the highest priority and 2147483647 is the lowest priority.
+      "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated.
+      "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single network policy rule.
+      "targetSecureTags": [ # A list of secure tags that controls which instances the traffic classification rule applies to. If targetSecureTag are specified, then the traffic classification rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the targetSecureTag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the traffic classification rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.
+        {
+          "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
+          "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
+        },
+      ],
+      "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.
+        "A String",
+      ],
+    },
+  ],
+}
+
+  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, read Handling 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 in RFC3339 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 in RFC3339 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 different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be 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 in RFC3339 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.
+}

+

+
+

+    patchTrafficClassificationRule(project, region, networkPolicy, body=None, priority=None, requestId=None, x__xgafv=None)
+  
Patches a rule of the specified priority.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region of this request. (required)
+  networkPolicy: string, Name of the network policy resource to update. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a traffic classification rule that describes one or more match conditions along with the action to be taken when traffic matches this condition.
+  "action": { # The Action to perform when the client connection triggers the rule.
+    "dscpMode": "A String", # The traffic class that should be applied to the matching packet.
+    "dscpValue": 42, # Custom DSCP value from 0-63 range.
+    "trafficClass": "A String", # The traffic class that should be applied to the matching packet.
+    "type": "A String", # Always "apply_traffic_classification" for traffic classification rules.
+  },
+  "description": "A String", # An optional description for this resource.
+  "disabled": True or False, # Denotes whether the network policy rule is disabled. When set to true, the network policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the network policy rule will be enabled.
+  "kind": "compute#networkPolicyTrafficClassificationRule", # [Output only] Type of the resource. Always compute#networkPolicyTrafficClassificationRule for network policy traffic classification rules
+  "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that outgoing traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
+    "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000.
+      "A String",
+    ],
+    "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.
+      {
+        "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a traffic classification rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.
+        "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
+          "A String",
+        ],
+      },
+    ],
+    "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000.
+      "A String",
+    ],
+  },
+  "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 1 and 2147482647. The priority values from 2147482648 to 2147483647 (1000) are reserved for system default network policy rules. Rules are evaluated from highest to lowest priority where 1 is the highest priority and 2147483647 is the lowest priority.
+  "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated.
+  "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single network policy rule.
+  "targetSecureTags": [ # A list of secure tags that controls which instances the traffic classification rule applies to. If targetSecureTag are specified, then the traffic classification rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the targetSecureTag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the traffic classification rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.
+    {
+      "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
+      "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
+    },
+  ],
+  "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.
+    "A String",
+  ],
+}
+
+  priority: integer, The priority of the traffic classification rule to patch. Only rules with a priority value between 1 and 2147482647 (inclusive) can be patched.
+  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, read Handling 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 in RFC3339 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 in RFC3339 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 different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be 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 in RFC3339 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.
+}

+

+
+

+    removeAssociation(project, region, networkPolicy, name=None, requestId=None, x__xgafv=None)
+  
Removes an association for the specified network policy.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region of this request. (required)
+  networkPolicy: string, Name of the network policy resource to update. (required)
+  name: string, Name for the association that will be removed.
+  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, read Handling 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 in RFC3339 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 in RFC3339 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 different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be 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 in RFC3339 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.
+}

+

+
+

+    removeTrafficClassificationRule(project, region, networkPolicy, priority=None, requestId=None, x__xgafv=None)
+  
Deletes a rule of the specified priority.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region of this request. (required)
+  networkPolicy: string, Name of the network policy resource to update. (required)
+  priority: integer, The priority of the rule to remove from the network policy.
+  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, read Handling 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 in RFC3339 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 in RFC3339 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 different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be 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 in RFC3339 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_beta.regionSnapshots.html b/docs/dyn/compute_beta.regionSnapshots.html
index bc21422f1c2..0be32121751 100644
--- a/docs/dyn/compute_beta.regionSnapshots.html
+++ b/docs/dyn/compute_beta.regionSnapshots.html
@@ -251,7 +251,7 @@ 
Method Details

 Returns:
   An object of the form:
 
-    { # Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. LINT.IfChange
+    { # Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots.
   "architecture": "A String", # [Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64.
   "autoCreated": True or False, # [Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk.
   "chainName": "A String", # Creates the new snapshot in the snapshot chain labeled with the specified name. The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value.
@@ -281,6 +281,11 @@ 
Method Details

   ],
   "locationHint": "A String", # An opaque location hint used to place the snapshot close to other resources. This field is for use by internal tools that use the public API.
   "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 with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+  "params": { # Additional snapshot params. # Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.
+    "resourceManagerTags": { # Resource manager tags to be bound to the snapshot. 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",
+    },
+  },
   "region": "A String", # [Output Only] URL of the region where the snapshot resides. Only applicable for regional snapshots.
   "satisfiesPzi": True or False, # Output only. Reserved for future use.
   "satisfiesPzs": True or False, # [Output Only] Reserved for future use.
@@ -386,7 +391,7 @@ 
Method Details

   body: object, The request body.
     The object takes the form of:
 
-{ # Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. LINT.IfChange
+{ # Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots.
   "architecture": "A String", # [Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64.
   "autoCreated": True or False, # [Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk.
   "chainName": "A String", # Creates the new snapshot in the snapshot chain labeled with the specified name. The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value.
@@ -416,6 +421,11 @@ 
Method Details

   ],
   "locationHint": "A String", # An opaque location hint used to place the snapshot close to other resources. This field is for use by internal tools that use the public API.
   "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 with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+  "params": { # Additional snapshot params. # Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.
+    "resourceManagerTags": { # Resource manager tags to be bound to the snapshot. 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",
+    },
+  },
   "region": "A String", # [Output Only] URL of the region where the snapshot resides. Only applicable for regional snapshots.
   "satisfiesPzi": True or False, # Output only. Reserved for future use.
   "satisfiesPzs": True or False, # [Output Only] Reserved for future use.
@@ -600,7 +610,7 @@ 
Method Details

     { # Contains a list of Snapshot resources.
   "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
   "items": [ # A list of Snapshot resources.
-    { # Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. LINT.IfChange
+    { # Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots.
       "architecture": "A String", # [Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64.
       "autoCreated": True or False, # [Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk.
       "chainName": "A String", # Creates the new snapshot in the snapshot chain labeled with the specified name. The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value.
@@ -630,6 +640,11 @@ 
Method Details

       ],
       "locationHint": "A String", # An opaque location hint used to place the snapshot close to other resources. This field is for use by internal tools that use the public API.
       "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 with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+      "params": { # Additional snapshot params. # Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.
+        "resourceManagerTags": { # Resource manager tags to be bound to the snapshot. 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",
+        },
+      },
       "region": "A String", # [Output Only] URL of the region where the snapshot resides. Only applicable for regional snapshots.
       "satisfiesPzi": True or False, # Output only. Reserved for future use.
       "satisfiesPzs": True or False, # [Output Only] Reserved for future use.
diff --git a/docs/dyn/compute_beta.reservationSubBlocks.html b/docs/dyn/compute_beta.reservationSubBlocks.html
index 0672700312a..4672a9558df 100644
--- a/docs/dyn/compute_beta.reservationSubBlocks.html
+++ b/docs/dyn/compute_beta.reservationSubBlocks.html
@@ -89,6 +89,9 @@ 
Instance Methods

 

   performMaintenance(project, zone, parentName, reservationSubBlock, requestId=None, x__xgafv=None)

 
Allows customers to perform maintenance on a reservation subBlock

+

+  reportFaulty(project, zone, parentName, reservationSubBlock, body=None, requestId=None, x__xgafv=None)

+
Allows customers to report a faulty subBlock.

 
Method Details

 

     close()
@@ -389,4 +392,144 @@ 
Method Details

 }
+
+ reportFaulty(project, zone, parentName, reservationSubBlock, body=None, requestId=None, x__xgafv=None) + 
Allows customers to report a faulty subBlock.
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, Name of the zone for this request. Zone name should conform to RFC1035. (required)
+  parentName: string, The name of the parent reservation and parent block. In the format of 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)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "disruptionSchedule": "A String", # The disruption schedule for the subBlock.
+  "failureComponent": "A String", # The component that experienced the fault.
+  "faultReasons": [ # The reasons for the fault experienced with the subBlock.
+    { # The reason for the fault experienced with the subBlock.
+      "behavior": "A String", # The behavior of the fault experienced with the subBlock.
+      "description": "A String", # The description of the fault experienced with the subBlock.
+    },
+  ],
+}
+
+  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, read Handling 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 in RFC3339 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 in RFC3339 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 different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be 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 in RFC3339 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_beta.snapshots.html b/docs/dyn/compute_beta.snapshots.html index e6f7c0c6b3f..9075093545e 100644 --- a/docs/dyn/compute_beta.snapshots.html +++ b/docs/dyn/compute_beta.snapshots.html @@ -138,7 +138,7 @@

Method Details

"items": { # A list of SnapshotsScopedList resources. "a_key": { # [Output Only] Name of the scope containing this set of snapshots. "snapshots": [ # [Output Only] A list of snapshots contained in this scope. - { # Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. LINT.IfChange + { # Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. "architecture": "A String", # [Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64. "autoCreated": True or False, # [Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk. "chainName": "A String", # Creates the new snapshot in the snapshot chain labeled with the specified name. The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value. @@ -168,6 +168,11 @@

Method Details

], "locationHint": "A String", # An opaque location hint used to place the snapshot close to other resources. This field is for use by internal tools that use the public API. "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 with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + "params": { # Additional snapshot params. # Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. + "resourceManagerTags": { # Resource manager tags to be bound to the snapshot. 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", + }, + }, "region": "A String", # [Output Only] URL of the region where the snapshot resides. Only applicable for regional snapshots. "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. @@ -401,7 +406,7 @@

Method Details

Returns: An object of the form: - { # Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. LINT.IfChange + { # Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. "architecture": "A String", # [Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64. "autoCreated": True or False, # [Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk. "chainName": "A String", # Creates the new snapshot in the snapshot chain labeled with the specified name. The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value. @@ -431,6 +436,11 @@

Method Details

], "locationHint": "A String", # An opaque location hint used to place the snapshot close to other resources. This field is for use by internal tools that use the public API. "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 with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + "params": { # Additional snapshot params. # Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. + "resourceManagerTags": { # Resource manager tags to be bound to the snapshot. 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", + }, + }, "region": "A String", # [Output Only] URL of the region where the snapshot resides. Only applicable for regional snapshots. "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. @@ -534,7 +544,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. LINT.IfChange +{ # Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. "architecture": "A String", # [Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64. "autoCreated": True or False, # [Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk. "chainName": "A String", # Creates the new snapshot in the snapshot chain labeled with the specified name. The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value. @@ -564,6 +574,11 @@

Method Details

], "locationHint": "A String", # An opaque location hint used to place the snapshot close to other resources. This field is for use by internal tools that use the public API. "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 with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + "params": { # Additional snapshot params. # Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. + "resourceManagerTags": { # Resource manager tags to be bound to the snapshot. 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", + }, + }, "region": "A String", # [Output Only] URL of the region where the snapshot resides. Only applicable for regional snapshots. "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. @@ -747,7 +762,7 @@

Method Details

{ # Contains a list of Snapshot resources. "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. "items": [ # A list of Snapshot resources. - { # Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. LINT.IfChange + { # Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. "architecture": "A String", # [Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64. "autoCreated": True or False, # [Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk. "chainName": "A String", # Creates the new snapshot in the snapshot chain labeled with the specified name. The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value. @@ -777,6 +792,11 @@

Method Details

], "locationHint": "A String", # An opaque location hint used to place the snapshot close to other resources. This field is for use by internal tools that use the public API. "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 with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + "params": { # Additional snapshot params. # Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. + "resourceManagerTags": { # Resource manager tags to be bound to the snapshot. 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", + }, + }, "region": "A String", # [Output Only] URL of the region where the snapshot resides. Only applicable for regional snapshots. "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. diff --git a/docs/dyn/compute_v1.backendServices.html b/docs/dyn/compute_v1.backendServices.html index 7b199c547ea..3694dd769ab 100644 --- a/docs/dyn/compute_v1.backendServices.html +++ b/docs/dyn/compute_v1.backendServices.html @@ -95,6 +95,9 @@

Instance Methods

get(project, backendService, x__xgafv=None)

Returns the specified BackendService resource.

+

+ getEffectiveSecurityPolicies(project, backendService, x__xgafv=None)

+

Returns effective security policies applied to this backend service.

getHealth(project, backendService, body=None, x__xgafv=None)

Gets the most recent health check results for this BackendService. Example request body: { "group": "/zones/us-east1-b/instanceGroups/lb-backend-example" }

@@ -1102,6 +1105,20 @@

Method Details

} +
+ getEffectiveSecurityPolicies(project, backendService, x__xgafv=None) + 
Returns effective security policies applied to this backend service.
+
+Args:
+  project: string, Project ID for this request. (required)
+  backendService: string, Name of the Backend Service for this request. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+
+
getHealth(project, backendService, body=None, x__xgafv=None) 
Gets the most recent health check results for this BackendService. Example request body: { "group": "/zones/us-east1-b/instanceGroups/lb-backend-example" }
diff --git a/docs/dyn/compute_v1.disks.html b/docs/dyn/compute_v1.disks.html
index 58562ca0955..620cb2814b5 100644
--- a/docs/dyn/compute_v1.disks.html
+++ b/docs/dyn/compute_v1.disks.html
@@ -746,7 +746,7 @@ 
Method Details

   body: object, The request body.
     The object takes the form of:
 
-{ # Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. LINT.IfChange
+{ # Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots.
   "architecture": "A String", # [Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64.
   "autoCreated": True or False, # [Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk.
   "chainName": "A String", # Creates the new snapshot in the snapshot chain labeled with the specified name. The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value.
@@ -776,6 +776,11 @@ 
Method Details

   ],
   "locationHint": "A String", # An opaque location hint used to place the snapshot close to other resources. This field is for use by internal tools that use the public API.
   "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 with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+  "params": { # Additional snapshot params. # Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.
+    "resourceManagerTags": { # Resource manager tags to be bound to the snapshot. 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",
+    },
+  },
   "satisfiesPzi": True or False, # Output only. Reserved for future use.
   "satisfiesPzs": True or False, # [Output Only] Reserved for future use.
   "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
diff --git a/docs/dyn/compute_v1.html b/docs/dyn/compute_v1.html
index 2b18da86150..21e92b6ada4 100644
--- a/docs/dyn/compute_v1.html
+++ b/docs/dyn/compute_v1.html
@@ -314,11 +314,21 @@ 
Instance Methods

 

 
Returns the nodeTypes Resource.

 
+

+  organizationSecurityPolicies()
+

+
Returns the organizationSecurityPolicies Resource.

+
 

   packetMirrorings()
 

 
Returns the packetMirrorings Resource.

 
+

+  previewFeatures()
+

+
Returns the previewFeatures Resource.

+
 

   projects()
 

diff --git a/docs/dyn/compute_v1.imageFamilyViews.html b/docs/dyn/compute_v1.imageFamilyViews.html
index 1870c2f5d33..ed1c6926eec 100644
--- a/docs/dyn/compute_v1.imageFamilyViews.html
+++ b/docs/dyn/compute_v1.imageFamilyViews.html
@@ -143,6 +143,11 @@ 
Method Details

       "A String",
     ],
     "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 with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+    "params": { # Additional image params. # Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.
+      "resourceManagerTags": { # Resource manager tags to be bound to the image. 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",
+      },
+    },
     "rawDisk": { # The parameters of the raw disk image.
       "containerType": "A String", # The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.
       "sha1Checksum": "A String", # [Deprecated] This field is deprecated. An optional SHA1 checksum of the disk image before unpackaging provided by the client when the disk image is created.
diff --git a/docs/dyn/compute_v1.images.html b/docs/dyn/compute_v1.images.html
index 6b1d5a0558c..4567fd58a2a 100644
--- a/docs/dyn/compute_v1.images.html
+++ b/docs/dyn/compute_v1.images.html
@@ -433,6 +433,11 @@ 
Method Details

     "A String",
   ],
   "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 with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+  "params": { # Additional image params. # Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.
+    "resourceManagerTags": { # Resource manager tags to be bound to the image. 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",
+    },
+  },
   "rawDisk": { # The parameters of the raw disk image.
     "containerType": "A String", # The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.
     "sha1Checksum": "A String", # [Deprecated] This field is deprecated. An optional SHA1 checksum of the disk image before unpackaging provided by the client when the disk image is created.
@@ -555,6 +560,11 @@ 
Method Details

     "A String",
   ],
   "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 with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+  "params": { # Additional image params. # Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.
+    "resourceManagerTags": { # Resource manager tags to be bound to the image. 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",
+    },
+  },
   "rawDisk": { # The parameters of the raw disk image.
     "containerType": "A String", # The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.
     "sha1Checksum": "A String", # [Deprecated] This field is deprecated. An optional SHA1 checksum of the disk image before unpackaging provided by the client when the disk image is created.
@@ -720,6 +730,11 @@ 
Method Details

     "A String",
   ],
   "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 with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+  "params": { # Additional image params. # Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.
+    "resourceManagerTags": { # Resource manager tags to be bound to the image. 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",
+    },
+  },
   "rawDisk": { # The parameters of the raw disk image.
     "containerType": "A String", # The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.
     "sha1Checksum": "A String", # [Deprecated] This field is deprecated. An optional SHA1 checksum of the disk image before unpackaging provided by the client when the disk image is created.
@@ -966,6 +981,11 @@ 
Method Details

         "A String",
       ],
       "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 with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+      "params": { # Additional image params. # Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.
+        "resourceManagerTags": { # Resource manager tags to be bound to the image. 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",
+        },
+      },
       "rawDisk": { # The parameters of the raw disk image.
         "containerType": "A String", # The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.
         "sha1Checksum": "A String", # [Deprecated] This field is deprecated. An optional SHA1 checksum of the disk image before unpackaging provided by the client when the disk image is created.
@@ -1112,6 +1132,11 @@ 
Method Details

     "A String",
   ],
   "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 with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+  "params": { # Additional image params. # Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.
+    "resourceManagerTags": { # Resource manager tags to be bound to the image. 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",
+    },
+  },
   "rawDisk": { # The parameters of the raw disk image.
     "containerType": "A String", # The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.
     "sha1Checksum": "A String", # [Deprecated] This field is deprecated. An optional SHA1 checksum of the disk image before unpackaging provided by the client when the disk image is created.
diff --git a/docs/dyn/compute_v1.interconnects.html b/docs/dyn/compute_v1.interconnects.html
index 77dda063684..b440eca143f 100644
--- a/docs/dyn/compute_v1.interconnects.html
+++ b/docs/dyn/compute_v1.interconnects.html
@@ -338,6 +338,7 @@ 
Method Details

   "satisfiesPzs": True or False, # [Output Only] Reserved for future use.
   "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
   "state": "A String", # [Output Only] The current state of Interconnect functionality, which can take one of the following values: - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect. - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect. - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.
+  "subzone": "A String", # Specific subzone in the InterconnectLocation that represents where this connection is to be provisioned.
 }
@@ -529,6 +530,7 @@

Method Details

"satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "state": "A String", # [Output Only] The current state of Interconnect functionality, which can take one of the following values: - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect. - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect. - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. + "subzone": "A String", # Specific subzone in the InterconnectLocation that represents where this connection is to be provisioned. } 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). @@ -759,6 +761,7 @@

Method Details

"satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "state": "A String", # [Output Only] The current state of Interconnect functionality, which can take one of the following values: - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect. - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect. - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. + "subzone": "A String", # Specific subzone in the InterconnectLocation that represents where this connection is to be provisioned. }, ], "kind": "compute#interconnectList", # [Output Only] Type of resource. Always compute#interconnectList for lists of interconnects. @@ -890,6 +893,7 @@

Method Details

"satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. "state": "A String", # [Output Only] The current state of Interconnect functionality, which can take one of the following values: - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect. - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect. - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. + "subzone": "A String", # Specific subzone in the InterconnectLocation that represents where this connection is to be provisioned. } 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). diff --git a/docs/dyn/compute_v1.organizationSecurityPolicies.html b/docs/dyn/compute_v1.organizationSecurityPolicies.html new file mode 100644 index 00000000000..f5a5e21c4ff --- /dev/null +++ b/docs/dyn/compute_v1.organizationSecurityPolicies.html @@ -0,0 +1,2867 @@ + + + +

Compute Engine API . organizationSecurityPolicies

+

Instance Methods

+

+ addAssociation(securityPolicy, body=None, replaceExistingAssociation=None, requestId=None, x__xgafv=None)

+

Inserts an association for the specified security policy. This has billing implications. Projects in the hierarchy with effective hierarchical security policies will be automatically enrolled into Cloud Armor Enterprise if not already enrolled. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.addAssociation instead if possible.

+

+ addRule(securityPolicy, body=None, requestId=None, x__xgafv=None)

+

Inserts a rule into a security policy.

+

+ close()

+

Close httplib2 connections.

+

+ copyRules(securityPolicy, requestId=None, sourceSecurityPolicy=None, x__xgafv=None)

+

Copies rules to the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.copyRules instead.

+

+ delete(securityPolicy, requestId=None, x__xgafv=None)

+

Deletes the specified policy. Use of this API to remove firewall policies is deprecated. Use firewallPolicies.delete instead.

+

+ get(securityPolicy, x__xgafv=None)

+

List all of the ordered rules present in a single specified policy. Use of this API to read firewall policies is deprecated. Use firewallPolicies.get instead.

+

+ getAssociation(securityPolicy, name=None, x__xgafv=None)

+

Gets an association with the specified name. Use of this API to read firewall policies is deprecated. Use firewallPolicies.getAssociation instead if possible.

+

+ getRule(securityPolicy, priority=None, x__xgafv=None)

+

Gets a rule at the specified priority. Use of this API to read firewall policies is deprecated. Use firewallPolicies.getRule instead.

+

+ insert(body=None, parentId=None, requestId=None, x__xgafv=None)

+

Creates a new policy in the specified project using the data included in the request. Use of this API to insert firewall policies is deprecated. Use firewallPolicies.insert instead.

+

+ list(filter=None, maxResults=None, orderBy=None, pageToken=None, parentId=None, returnPartialSuccess=None, x__xgafv=None)

+

List all the policies that have been configured for the specified project. Use of this API to read firewall policies is deprecated. Use firewallPolicies.list instead.

+

+ listAssociations(targetResource=None, x__xgafv=None)

+

Lists associations of a specified target, i.e., organization or folder. Use of this API to read firewall policies is deprecated. Use firewallPolicies.listAssociations instead if possible.

+

+ listPreconfiguredExpressionSets(filter=None, maxResults=None, orderBy=None, pageToken=None, parentId=None, returnPartialSuccess=None, x__xgafv=None)

+

Gets the current list of preconfigured Web Application Firewall (WAF) expressions.

+

+ list_next()

+

Retrieves the next page of results.

+

+ move(securityPolicy, parentId=None, requestId=None, x__xgafv=None)

+

Moves the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.move instead.

+

+ patch(securityPolicy, body=None, requestId=None, x__xgafv=None)

+

Patches the specified policy with the data included in the request. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.patch instead.

+

+ patchRule(securityPolicy, body=None, priority=None, requestId=None, x__xgafv=None)

+

Patches a rule at the specified priority. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.patchRule instead.

+

+ removeAssociation(securityPolicy, name=None, requestId=None, x__xgafv=None)

+

Removes an association for the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.removeAssociation instead if possible.

+

+ removeRule(securityPolicy, priority=None, requestId=None, x__xgafv=None)

+

Deletes a rule at the specified priority.

+

Method Details

+
+ addAssociation(securityPolicy, body=None, replaceExistingAssociation=None, requestId=None, x__xgafv=None) + 
Inserts an association for the specified security policy. This has billing implications. Projects in the hierarchy with effective hierarchical security policies will be automatically enrolled into Cloud Armor Enterprise if not already enrolled. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.addAssociation instead if possible.
+
+Args:
+  securityPolicy: string, Name of the security policy to update. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "attachmentId": "A String", # The resource that the security policy is attached to.
+  "displayName": "A String", # [Output Only] The display name of the security policy of the association.
+  "excludedFolders": [ # A list of folders to exclude from the security policy.
+    "A String",
+  ],
+  "excludedProjects": [ # A list of projects to exclude from the security policy.
+    "A String",
+  ],
+  "name": "A String", # The name for an association.
+  "securityPolicyId": "A String", # [Output Only] The security policy ID of the association.
+  "shortName": "A String", # [Output Only] The short name of the security policy of the association.
+}
+
+  replaceExistingAssociation: boolean, Indicates whether or not to replace it if an association of the attachment already exists. This is false by default, in which case an error will be returned if an association already exists.
+  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/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling 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 in RFC3339 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 in RFC3339 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 different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be 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 in RFC3339 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.
+}
+
+ +
+ addRule(securityPolicy, body=None, requestId=None, x__xgafv=None) + 
Inserts a rule into a security policy.
+
+Args:
+  securityPolicy: string, Name of the security policy to update. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).
+  "action": "A String", # The Action to perform when the rule is matched. The following are the valid actions: - allow: allow access to target. - deny(STATUS): deny access to target, returns the HTTP response code specified. Valid values for `STATUS` are 403, 404, and 502. - rate_based_ban: limit client traffic to the configured threshold and ban the client if the traffic exceeds the threshold. Configure parameters for this action in RateLimitOptions. Requires rate_limit_options to be set. - redirect: redirect to a different target. This can either be an internal reCAPTCHA redirect, or an external URL-based redirect via a 302 response. Parameters for this action can be configured via redirectOptions. This action is only supported in Global Security Policies of type CLOUD_ARMOR. - throttle: limit client traffic to the configured threshold. Configure parameters for this action in rateLimitOptions. Requires rate_limit_options to be set for this. - fairshare (preview only): when traffic reaches the threshold limit, requests from the clients matching this rule begin to be rate-limited using the Fair Share algorithm. This action is only allowed in security policies of type `CLOUD_ARMOR_INTERNAL_SERVICE`.
+  "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+  "headerAction": { # Optional, additional actions that are performed on headers. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
+    "requestHeadersToAdds": [ # The list of request headers to add or overwrite if they're already present.
+      {
+        "headerName": "A String", # The name of the header to set.
+        "headerValue": "A String", # The value to set the named header to.
+      },
+    ],
+  },
+  "kind": "compute#securityPolicyRule", # [Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules
+  "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
+    "config": { # The configuration options available when specifying versioned_expr. This field must be specified if versioned_expr is specified and cannot be specified if versioned_expr is not specified.
+      "srcIpRanges": [ # CIDR IP address range. Maximum number of src_ip_ranges allowed is 10.
+        "A String",
+      ],
+    },
+    "expr": { # 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. # User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header. Expressions containing `evaluateThreatIntelligence` require a Cloud Armor Enterprise subscription and are not supported in Edge Policies nor in Regional Policies. Expressions containing `evaluatePreconfiguredExpr('sourceiplist-*')` require a Cloud Armor Enterprise subscription and are only supported in Global Security 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.
+    },
+    "exprOptions": { # The configuration options available when specifying a user defined CEVAL expression (i.e., 'expr').
+      "recaptchaOptions": { # reCAPTCHA configuration options to be applied for the rule. If the rule does not evaluate reCAPTCHA tokens, this field has no effect.
+        "actionTokenSiteKeys": [ # A list of site keys to be used during the validation of reCAPTCHA action-tokens. The provided site keys need to be created from reCAPTCHA API under the same project where the security policy is created.
+          "A String",
+        ],
+        "sessionTokenSiteKeys": [ # A list of site keys to be used during the validation of reCAPTCHA session-tokens. The provided site keys need to be created from reCAPTCHA API under the same project where the security policy is created.
+          "A String",
+        ],
+      },
+    },
+    "versionedExpr": "A String", # Preconfigured versioned expression. If this field is specified, config must also be specified. Available preconfigured expressions along with their requirements are: SRC_IPS_V1 - must specify the corresponding src_ip_range field in config.
+  },
+  "networkMatch": { # Represents a match condition that incoming network traffic is evaluated against. # A match condition that incoming packets are evaluated against for CLOUD_ARMOR_NETWORK security policies. If it matches, the corresponding 'action' is enforced. The match criteria for a rule consists of built-in match fields (like 'srcIpRanges') and potentially multiple user-defined match fields ('userDefinedFields'). Field values may be extracted directly from the packet or derived from it (e.g. 'srcRegionCodes'). Some fields may not be present in every packet (e.g. 'srcPorts'). A user-defined field is only present if the base header is found in the packet and the entire field is in bounds. Each match field may specify which values can match it, listing one or more ranges, prefixes, or exact values that are considered a match for the field. A field value must be present in order to match a specified match field. If no match values are specified for a match field, then any field value is considered to match it, and it's not required to be present. For strings specifying '*' is also equivalent to match all. For a packet to match a rule, all specified match fields must match the corresponding field values derived from the packet. Example: networkMatch: srcIpRanges: - "192.0.2.0/24" - "198.51.100.0/24" userDefinedFields: - name: "ipv4_fragment_offset" values: - "1-0x1fff" The above match condition matches packets with a source IP in 192.0.2.0/24 or 198.51.100.0/24 and a user-defined field named "ipv4_fragment_offset" with a value between 1 and 0x1fff inclusive.
+    "destIpRanges": [ # Destination IPv4/IPv6 addresses or CIDR prefixes, in standard text format.
+      "A String",
+    ],
+    "destPorts": [ # Destination port numbers for TCP/UDP/SCTP. Each element can be a 16-bit unsigned decimal number (e.g. "80") or range (e.g. "0-1023").
+      "A String",
+    ],
+    "ipProtocols": [ # IPv4 protocol / IPv6 next header (after extension headers). Each element can be an 8-bit unsigned decimal number (e.g. "6"), range (e.g. "253-254"), or one of the following protocol names: "tcp", "udp", "icmp", "esp", "ah", "ipip", or "sctp".
+      "A String",
+    ],
+    "srcAsns": [ # BGP Autonomous System Number associated with the source IP address.
+      42,
+    ],
+    "srcIpRanges": [ # Source IPv4/IPv6 addresses or CIDR prefixes, in standard text format.
+      "A String",
+    ],
+    "srcPorts": [ # Source port numbers for TCP/UDP/SCTP. Each element can be a 16-bit unsigned decimal number (e.g. "80") or range (e.g. "0-1023").
+      "A String",
+    ],
+    "srcRegionCodes": [ # Two-letter ISO 3166-1 alpha-2 country code associated with the source IP address.
+      "A String",
+    ],
+    "userDefinedFields": [ # User-defined fields. Each element names a defined field and lists the matching values for that field.
+      {
+        "name": "A String", # Name of the user-defined field, as given in the definition.
+        "values": [ # Matching values of the field. Each element can be a 32-bit unsigned decimal or hexadecimal (starting with "0x") number (e.g. "64") or range (e.g. "0x400-0x7ff").
+          "A String",
+        ],
+      },
+    ],
+  },
+  "preconfiguredWafConfig": { # Preconfigured WAF configuration to be applied for the rule. If the rule does not evaluate preconfigured WAF rules, i.e., if evaluatePreconfiguredWaf() is not used, this field will have no effect.
+    "exclusions": [ # A list of exclusions to apply during preconfigured WAF evaluation.
+      {
+        "requestCookiesToExclude": [ # A list of request cookie names whose value will be excluded from inspection during preconfigured WAF evaluation.
+          {
+            "op": "A String", # The match operator for the field.
+            "val": "A String", # The value of the field.
+          },
+        ],
+        "requestHeadersToExclude": [ # A list of request header names whose value will be excluded from inspection during preconfigured WAF evaluation.
+          {
+            "op": "A String", # The match operator for the field.
+            "val": "A String", # The value of the field.
+          },
+        ],
+        "requestQueryParamsToExclude": [ # A list of request query parameter names whose value will be excluded from inspection during preconfigured WAF evaluation. Note that the parameter can be in the query string or in the POST body.
+          {
+            "op": "A String", # The match operator for the field.
+            "val": "A String", # The value of the field.
+          },
+        ],
+        "requestUrisToExclude": [ # A list of request URIs from the request line to be excluded from inspection during preconfigured WAF evaluation. When specifying this field, the query or fragment part should be excluded.
+          {
+            "op": "A String", # The match operator for the field.
+            "val": "A String", # The value of the field.
+          },
+        ],
+        "targetRuleIds": [ # A list of target rule IDs under the WAF rule set to apply the preconfigured WAF exclusion. If omitted, it refers to all the rule IDs under the WAF rule set.
+          "A String",
+        ],
+        "targetRuleSet": "A String", # Target WAF rule set to apply the preconfigured WAF exclusion.
+      },
+    ],
+  },
+  "preview": True or False, # If set to true, the specified action is not enforced.
+  "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority.
+  "rateLimitOptions": { # Must be specified if the action is "rate_based_ban" or "throttle" or "fairshare". Cannot be specified for any other actions.
+    "banDurationSec": 42, # Can only be specified if the action for the rule is "rate_based_ban". If specified, determines the time (in seconds) the traffic will continue to be banned by the rate limit after the rate falls below the threshold.
+    "banThreshold": { # Can only be specified if the action for the rule is "rate_based_ban". If specified, the key will be banned for the configured 'ban_duration_sec' when the number of requests that exceed the 'rate_limit_threshold' also exceed this 'ban_threshold'.
+      "count": 42, # Number of HTTP(S) requests for calculating the threshold.
+      "intervalSec": 42, # Interval over which the threshold is computed.
+    },
+    "conformAction": "A String", # Action to take for requests that are under the configured rate limit threshold. Valid option is "allow" only.
+    "enforceOnKey": "A String", # Determines the key to enforce the rate_limit_threshold on. Possible values are: - ALL: A single rate limit threshold is applied to all the requests matching this rule. This is the default value if "enforceOnKey" is not configured. - IP: The source IP address of the request is the key. Each IP has this limit enforced separately. - HTTP_HEADER: The value of the HTTP header whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to ALL. - XFF_IP: The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type IP. - HTTP_COOKIE: The value of the HTTP cookie whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to ALL. - HTTP_PATH: The URL path of the HTTP request. The key value is truncated to the first 128 bytes. - SNI: Server name indication in the TLS session of the HTTPS request. The key value is truncated to the first 128 bytes. The key type defaults to ALL on a HTTP session. - REGION_CODE: The country/region from which the request originates. - TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL. - USER_IP: The IP address of the originating client, which is resolved based on "userIpRequestHeaders" configured with the security policy. If there is no "userIpRequestHeaders" configuration or an IP address cannot be resolved from it, the key type defaults to IP. - TLS_JA4_FINGERPRINT: JA4 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL. For "fairshare" action, this value is limited to ALL i.e. a single rate limit threshold is enforced for all the requests matching the rule.
+    "enforceOnKeyConfigs": [ # If specified, any combination of values of enforce_on_key_type/enforce_on_key_name is treated as the key on which ratelimit threshold/action is enforced. You can specify up to 3 enforce_on_key_configs. If enforce_on_key_configs is specified, enforce_on_key must not be specified.
+      {
+        "enforceOnKeyName": "A String", # Rate limit key name applicable only for the following key types: HTTP_HEADER -- Name of the HTTP header whose value is taken as the key value. HTTP_COOKIE -- Name of the HTTP cookie whose value is taken as the key value.
+        "enforceOnKeyType": "A String", # Determines the key to enforce the rate_limit_threshold on. Possible values are: - ALL: A single rate limit threshold is applied to all the requests matching this rule. This is the default value if "enforceOnKeyConfigs" is not configured. - IP: The source IP address of the request is the key. Each IP has this limit enforced separately. - HTTP_HEADER: The value of the HTTP header whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to ALL. - XFF_IP: The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type IP. - HTTP_COOKIE: The value of the HTTP cookie whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to ALL. - HTTP_PATH: The URL path of the HTTP request. The key value is truncated to the first 128 bytes. - SNI: Server name indication in the TLS session of the HTTPS request. The key value is truncated to the first 128 bytes. The key type defaults to ALL on a HTTP session. - REGION_CODE: The country/region from which the request originates. - TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL. - USER_IP: The IP address of the originating client, which is resolved based on "userIpRequestHeaders" configured with the security policy. If there is no "userIpRequestHeaders" configuration or an IP address cannot be resolved from it, the key type defaults to IP. - TLS_JA4_FINGERPRINT: JA4 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL.
+      },
+    ],
+    "enforceOnKeyName": "A String", # Rate limit key name applicable only for the following key types: HTTP_HEADER -- Name of the HTTP header whose value is taken as the key value. HTTP_COOKIE -- Name of the HTTP cookie whose value is taken as the key value.
+    "exceedAction": "A String", # Action to take for requests that are above the configured rate limit threshold, to either deny with a specified HTTP response code, or redirect to a different endpoint. Valid options are `deny(STATUS)`, where valid values for `STATUS` are 403, 404, 429, and 502, and `redirect`, where the redirect parameters come from `exceedRedirectOptions` below. The `redirect` action is only supported in Global Security Policies of type CLOUD_ARMOR.
+    "exceedRedirectOptions": { # Parameters defining the redirect action that is used as the exceed action. Cannot be specified if the exceed action is not redirect. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
+      "target": "A String", # Target for the redirect action. This is required if the type is EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA.
+      "type": "A String", # Type of the redirect action. Possible values are: - GOOGLE_RECAPTCHA: redirect to reCAPTCHA for manual challenge assessment. - EXTERNAL_302: redirect to a different URL via a 302 response.
+    },
+    "rateLimitThreshold": { # Threshold at which to begin ratelimiting.
+      "count": 42, # Number of HTTP(S) requests for calculating the threshold.
+      "intervalSec": 42, # Interval over which the threshold is computed.
+    },
+  },
+  "redirectOptions": { # Parameters defining the redirect action. Cannot be specified for any other actions. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
+    "target": "A String", # Target for the redirect action. This is required if the type is EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA.
+    "type": "A String", # Type of the redirect action. Possible values are: - GOOGLE_RECAPTCHA: redirect to reCAPTCHA for manual challenge assessment. - EXTERNAL_302: redirect to a different URL via a 302 response.
+  },
+}
+
+  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/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling 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 in RFC3339 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 in RFC3339 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 different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be 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 in RFC3339 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.
+
+ +
+ copyRules(securityPolicy, requestId=None, sourceSecurityPolicy=None, x__xgafv=None) + 
Copies rules to the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.copyRules instead.
+
+Args:
+  securityPolicy: string, Name of the security policy to update. (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).
+  sourceSecurityPolicy: string, The security policy from which to copy rules.
+  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/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling 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 in RFC3339 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 in RFC3339 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 different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be 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 in RFC3339 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.
+}
+
+ +
+ delete(securityPolicy, requestId=None, x__xgafv=None) + 
Deletes the specified policy. Use of this API to remove firewall policies is deprecated. Use firewallPolicies.delete instead.
+
+Args:
+  securityPolicy: string, Name of the security 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/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling 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 in RFC3339 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 in RFC3339 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 different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be 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 in RFC3339 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(securityPolicy, x__xgafv=None) + 
List all of the ordered rules present in a single specified policy. Use of this API to read firewall policies is deprecated. Use firewallPolicies.get instead.
+
+Args:
+  securityPolicy: string, Name of the security policy to get. (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 Google Cloud Armor security policy resource. Only external backend services that use load balancers can reference a security policy. For more information, see Google Cloud Armor security policy overview.
+  "adaptiveProtectionConfig": { # Configuration options for Cloud Armor Adaptive Protection (CAAP).
+    "layer7DdosDefenseConfig": { # Configuration options for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR. # If set to true, enables Cloud Armor Machine Learning.
+      "enable": True or False, # If set to true, enables CAAP for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
+      "ruleVisibility": "A String", # Rule visibility can be one of the following: STANDARD - opaque rules. (default) PREMIUM - transparent rules. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
+      "thresholdConfigs": [ # Configuration options for layer7 adaptive protection for various customizable thresholds.
+        {
+          "autoDeployConfidenceThreshold": 3.14,
+          "autoDeployExpirationSec": 42,
+          "autoDeployImpactedBaselineThreshold": 3.14,
+          "autoDeployLoadThreshold": 3.14,
+          "detectionAbsoluteQps": 3.14,
+          "detectionLoadThreshold": 3.14,
+          "detectionRelativeToBaselineQps": 3.14,
+          "name": "A String", # The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the security policy.
+          "trafficGranularityConfigs": [ # Configuration options for enabling Adaptive Protection to operate on specified granular traffic units.
+            { # Configurations to specifc granular traffic units processed by Adaptive Protection.
+              "enableEachUniqueValue": True or False, # If enabled, traffic matching each unique value for the specified type constitutes a separate traffic unit. It can only be set to true if `value` is empty.
+              "type": "A String", # Type of this configuration.
+              "value": "A String", # Requests that match this value constitute a granular traffic unit.
+            },
+          ],
+        },
+      ],
+    },
+  },
+  "advancedOptionsConfig": {
+    "jsonCustomConfig": { # Custom configuration to apply the JSON parsing. Only applicable when json_parsing is set to STANDARD.
+      "contentTypes": [ # A list of custom Content-Type header values to apply the JSON parsing. As per RFC 1341, a Content-Type header value has the following format: Content-Type := type "/" subtype *[";" parameter] When configuring a custom Content-Type header value, only the type/subtype needs to be specified, and the parameters should be excluded.
+        "A String",
+      ],
+    },
+    "jsonParsing": "A String",
+    "logLevel": "A String",
+    "userIpRequestHeaders": [ # An optional list of case-insensitive request header names to use for resolving the callers client IP address.
+      "A String",
+    ],
+  },
+  "associations": [ # A list of associations that belong to this policy.
+    {
+      "attachmentId": "A String", # The resource that the security policy is attached to.
+      "displayName": "A String", # [Output Only] The display name of the security policy of the association.
+      "excludedFolders": [ # A list of folders to exclude from the security policy.
+        "A String",
+      ],
+      "excludedProjects": [ # A list of projects to exclude from the security policy.
+        "A String",
+      ],
+      "name": "A String", # The name for an association.
+      "securityPolicyId": "A String", # [Output Only] The security policy ID of the association.
+      "shortName": "A String", # [Output Only] The short name of the security policy of the association.
+    },
+  ],
+  "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+  "ddosProtectionConfig": {
+    "ddosProtection": "A String",
+  },
+  "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+  "fingerprint": "A String", # Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the security policy.
+  "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+  "kind": "compute#securityPolicy", # [Output only] Type of the resource. Always compute#securityPolicyfor security policies
+  "labelFingerprint": "A String", # A fingerprint for the labels being applied to this security policy, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the security policy.
+  "labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
+    "a_key": "A String",
+  },
+  "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 with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+  "recaptchaOptionsConfig": {
+    "redirectSiteKey": "A String", # An optional field to supply a reCAPTCHA site key to be used for all the rules using the redirect action with the type of GOOGLE_RECAPTCHA under the security policy. The specified site key needs to be created from the reCAPTCHA API. The user is responsible for the validity of the specified site key. If not specified, a Google-managed site key is used. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
+  },
+  "region": "A String", # [Output Only] URL of the region where the regional security policy resides. This field is not applicable to global security policies.
+  "rules": [ # A list of rules that belong to this policy. There must always be a default rule which is a rule with priority 2147483647 and match all condition (for the match condition this means match "*" for srcIpRanges and for the networkMatch condition every field must be either match "*" or not set). If no rules are provided when creating a security policy, a default rule with action "allow" will be added.
+    { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).
+      "action": "A String", # The Action to perform when the rule is matched. The following are the valid actions: - allow: allow access to target. - deny(STATUS): deny access to target, returns the HTTP response code specified. Valid values for `STATUS` are 403, 404, and 502. - rate_based_ban: limit client traffic to the configured threshold and ban the client if the traffic exceeds the threshold. Configure parameters for this action in RateLimitOptions. Requires rate_limit_options to be set. - redirect: redirect to a different target. This can either be an internal reCAPTCHA redirect, or an external URL-based redirect via a 302 response. Parameters for this action can be configured via redirectOptions. This action is only supported in Global Security Policies of type CLOUD_ARMOR. - throttle: limit client traffic to the configured threshold. Configure parameters for this action in rateLimitOptions. Requires rate_limit_options to be set for this. - fairshare (preview only): when traffic reaches the threshold limit, requests from the clients matching this rule begin to be rate-limited using the Fair Share algorithm. This action is only allowed in security policies of type `CLOUD_ARMOR_INTERNAL_SERVICE`.
+      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+      "headerAction": { # Optional, additional actions that are performed on headers. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
+        "requestHeadersToAdds": [ # The list of request headers to add or overwrite if they're already present.
+          {
+            "headerName": "A String", # The name of the header to set.
+            "headerValue": "A String", # The value to set the named header to.
+          },
+        ],
+      },
+      "kind": "compute#securityPolicyRule", # [Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules
+      "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
+        "config": { # The configuration options available when specifying versioned_expr. This field must be specified if versioned_expr is specified and cannot be specified if versioned_expr is not specified.
+          "srcIpRanges": [ # CIDR IP address range. Maximum number of src_ip_ranges allowed is 10.
+            "A String",
+          ],
+        },
+        "expr": { # 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. # User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header. Expressions containing `evaluateThreatIntelligence` require a Cloud Armor Enterprise subscription and are not supported in Edge Policies nor in Regional Policies. Expressions containing `evaluatePreconfiguredExpr('sourceiplist-*')` require a Cloud Armor Enterprise subscription and are only supported in Global Security 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.
+        },
+        "exprOptions": { # The configuration options available when specifying a user defined CEVAL expression (i.e., 'expr').
+          "recaptchaOptions": { # reCAPTCHA configuration options to be applied for the rule. If the rule does not evaluate reCAPTCHA tokens, this field has no effect.
+            "actionTokenSiteKeys": [ # A list of site keys to be used during the validation of reCAPTCHA action-tokens. The provided site keys need to be created from reCAPTCHA API under the same project where the security policy is created.
+              "A String",
+            ],
+            "sessionTokenSiteKeys": [ # A list of site keys to be used during the validation of reCAPTCHA session-tokens. The provided site keys need to be created from reCAPTCHA API under the same project where the security policy is created.
+              "A String",
+            ],
+          },
+        },
+        "versionedExpr": "A String", # Preconfigured versioned expression. If this field is specified, config must also be specified. Available preconfigured expressions along with their requirements are: SRC_IPS_V1 - must specify the corresponding src_ip_range field in config.
+      },
+      "networkMatch": { # Represents a match condition that incoming network traffic is evaluated against. # A match condition that incoming packets are evaluated against for CLOUD_ARMOR_NETWORK security policies. If it matches, the corresponding 'action' is enforced. The match criteria for a rule consists of built-in match fields (like 'srcIpRanges') and potentially multiple user-defined match fields ('userDefinedFields'). Field values may be extracted directly from the packet or derived from it (e.g. 'srcRegionCodes'). Some fields may not be present in every packet (e.g. 'srcPorts'). A user-defined field is only present if the base header is found in the packet and the entire field is in bounds. Each match field may specify which values can match it, listing one or more ranges, prefixes, or exact values that are considered a match for the field. A field value must be present in order to match a specified match field. If no match values are specified for a match field, then any field value is considered to match it, and it's not required to be present. For strings specifying '*' is also equivalent to match all. For a packet to match a rule, all specified match fields must match the corresponding field values derived from the packet. Example: networkMatch: srcIpRanges: - "192.0.2.0/24" - "198.51.100.0/24" userDefinedFields: - name: "ipv4_fragment_offset" values: - "1-0x1fff" The above match condition matches packets with a source IP in 192.0.2.0/24 or 198.51.100.0/24 and a user-defined field named "ipv4_fragment_offset" with a value between 1 and 0x1fff inclusive.
+        "destIpRanges": [ # Destination IPv4/IPv6 addresses or CIDR prefixes, in standard text format.
+          "A String",
+        ],
+        "destPorts": [ # Destination port numbers for TCP/UDP/SCTP. Each element can be a 16-bit unsigned decimal number (e.g. "80") or range (e.g. "0-1023").
+          "A String",
+        ],
+        "ipProtocols": [ # IPv4 protocol / IPv6 next header (after extension headers). Each element can be an 8-bit unsigned decimal number (e.g. "6"), range (e.g. "253-254"), or one of the following protocol names: "tcp", "udp", "icmp", "esp", "ah", "ipip", or "sctp".
+          "A String",
+        ],
+        "srcAsns": [ # BGP Autonomous System Number associated with the source IP address.
+          42,
+        ],
+        "srcIpRanges": [ # Source IPv4/IPv6 addresses or CIDR prefixes, in standard text format.
+          "A String",
+        ],
+        "srcPorts": [ # Source port numbers for TCP/UDP/SCTP. Each element can be a 16-bit unsigned decimal number (e.g. "80") or range (e.g. "0-1023").
+          "A String",
+        ],
+        "srcRegionCodes": [ # Two-letter ISO 3166-1 alpha-2 country code associated with the source IP address.
+          "A String",
+        ],
+        "userDefinedFields": [ # User-defined fields. Each element names a defined field and lists the matching values for that field.
+          {
+            "name": "A String", # Name of the user-defined field, as given in the definition.
+            "values": [ # Matching values of the field. Each element can be a 32-bit unsigned decimal or hexadecimal (starting with "0x") number (e.g. "64") or range (e.g. "0x400-0x7ff").
+              "A String",
+            ],
+          },
+        ],
+      },
+      "preconfiguredWafConfig": { # Preconfigured WAF configuration to be applied for the rule. If the rule does not evaluate preconfigured WAF rules, i.e., if evaluatePreconfiguredWaf() is not used, this field will have no effect.
+        "exclusions": [ # A list of exclusions to apply during preconfigured WAF evaluation.
+          {
+            "requestCookiesToExclude": [ # A list of request cookie names whose value will be excluded from inspection during preconfigured WAF evaluation.
+              {
+                "op": "A String", # The match operator for the field.
+                "val": "A String", # The value of the field.
+              },
+            ],
+            "requestHeadersToExclude": [ # A list of request header names whose value will be excluded from inspection during preconfigured WAF evaluation.
+              {
+                "op": "A String", # The match operator for the field.
+                "val": "A String", # The value of the field.
+              },
+            ],
+            "requestQueryParamsToExclude": [ # A list of request query parameter names whose value will be excluded from inspection during preconfigured WAF evaluation. Note that the parameter can be in the query string or in the POST body.
+              {
+                "op": "A String", # The match operator for the field.
+                "val": "A String", # The value of the field.
+              },
+            ],
+            "requestUrisToExclude": [ # A list of request URIs from the request line to be excluded from inspection during preconfigured WAF evaluation. When specifying this field, the query or fragment part should be excluded.
+              {
+                "op": "A String", # The match operator for the field.
+                "val": "A String", # The value of the field.
+              },
+            ],
+            "targetRuleIds": [ # A list of target rule IDs under the WAF rule set to apply the preconfigured WAF exclusion. If omitted, it refers to all the rule IDs under the WAF rule set.
+              "A String",
+            ],
+            "targetRuleSet": "A String", # Target WAF rule set to apply the preconfigured WAF exclusion.
+          },
+        ],
+      },
+      "preview": True or False, # If set to true, the specified action is not enforced.
+      "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority.
+      "rateLimitOptions": { # Must be specified if the action is "rate_based_ban" or "throttle" or "fairshare". Cannot be specified for any other actions.
+        "banDurationSec": 42, # Can only be specified if the action for the rule is "rate_based_ban". If specified, determines the time (in seconds) the traffic will continue to be banned by the rate limit after the rate falls below the threshold.
+        "banThreshold": { # Can only be specified if the action for the rule is "rate_based_ban". If specified, the key will be banned for the configured 'ban_duration_sec' when the number of requests that exceed the 'rate_limit_threshold' also exceed this 'ban_threshold'.
+          "count": 42, # Number of HTTP(S) requests for calculating the threshold.
+          "intervalSec": 42, # Interval over which the threshold is computed.
+        },
+        "conformAction": "A String", # Action to take for requests that are under the configured rate limit threshold. Valid option is "allow" only.
+        "enforceOnKey": "A String", # Determines the key to enforce the rate_limit_threshold on. Possible values are: - ALL: A single rate limit threshold is applied to all the requests matching this rule. This is the default value if "enforceOnKey" is not configured. - IP: The source IP address of the request is the key. Each IP has this limit enforced separately. - HTTP_HEADER: The value of the HTTP header whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to ALL. - XFF_IP: The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type IP. - HTTP_COOKIE: The value of the HTTP cookie whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to ALL. - HTTP_PATH: The URL path of the HTTP request. The key value is truncated to the first 128 bytes. - SNI: Server name indication in the TLS session of the HTTPS request. The key value is truncated to the first 128 bytes. The key type defaults to ALL on a HTTP session. - REGION_CODE: The country/region from which the request originates. - TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL. - USER_IP: The IP address of the originating client, which is resolved based on "userIpRequestHeaders" configured with the security policy. If there is no "userIpRequestHeaders" configuration or an IP address cannot be resolved from it, the key type defaults to IP. - TLS_JA4_FINGERPRINT: JA4 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL. For "fairshare" action, this value is limited to ALL i.e. a single rate limit threshold is enforced for all the requests matching the rule.
+        "enforceOnKeyConfigs": [ # If specified, any combination of values of enforce_on_key_type/enforce_on_key_name is treated as the key on which ratelimit threshold/action is enforced. You can specify up to 3 enforce_on_key_configs. If enforce_on_key_configs is specified, enforce_on_key must not be specified.
+          {
+            "enforceOnKeyName": "A String", # Rate limit key name applicable only for the following key types: HTTP_HEADER -- Name of the HTTP header whose value is taken as the key value. HTTP_COOKIE -- Name of the HTTP cookie whose value is taken as the key value.
+            "enforceOnKeyType": "A String", # Determines the key to enforce the rate_limit_threshold on. Possible values are: - ALL: A single rate limit threshold is applied to all the requests matching this rule. This is the default value if "enforceOnKeyConfigs" is not configured. - IP: The source IP address of the request is the key. Each IP has this limit enforced separately. - HTTP_HEADER: The value of the HTTP header whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to ALL. - XFF_IP: The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type IP. - HTTP_COOKIE: The value of the HTTP cookie whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to ALL. - HTTP_PATH: The URL path of the HTTP request. The key value is truncated to the first 128 bytes. - SNI: Server name indication in the TLS session of the HTTPS request. The key value is truncated to the first 128 bytes. The key type defaults to ALL on a HTTP session. - REGION_CODE: The country/region from which the request originates. - TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL. - USER_IP: The IP address of the originating client, which is resolved based on "userIpRequestHeaders" configured with the security policy. If there is no "userIpRequestHeaders" configuration or an IP address cannot be resolved from it, the key type defaults to IP. - TLS_JA4_FINGERPRINT: JA4 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL.
+          },
+        ],
+        "enforceOnKeyName": "A String", # Rate limit key name applicable only for the following key types: HTTP_HEADER -- Name of the HTTP header whose value is taken as the key value. HTTP_COOKIE -- Name of the HTTP cookie whose value is taken as the key value.
+        "exceedAction": "A String", # Action to take for requests that are above the configured rate limit threshold, to either deny with a specified HTTP response code, or redirect to a different endpoint. Valid options are `deny(STATUS)`, where valid values for `STATUS` are 403, 404, 429, and 502, and `redirect`, where the redirect parameters come from `exceedRedirectOptions` below. The `redirect` action is only supported in Global Security Policies of type CLOUD_ARMOR.
+        "exceedRedirectOptions": { # Parameters defining the redirect action that is used as the exceed action. Cannot be specified if the exceed action is not redirect. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
+          "target": "A String", # Target for the redirect action. This is required if the type is EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA.
+          "type": "A String", # Type of the redirect action. Possible values are: - GOOGLE_RECAPTCHA: redirect to reCAPTCHA for manual challenge assessment. - EXTERNAL_302: redirect to a different URL via a 302 response.
+        },
+        "rateLimitThreshold": { # Threshold at which to begin ratelimiting.
+          "count": 42, # Number of HTTP(S) requests for calculating the threshold.
+          "intervalSec": 42, # Interval over which the threshold is computed.
+        },
+      },
+      "redirectOptions": { # Parameters defining the redirect action. Cannot be specified for any other actions. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
+        "target": "A String", # Target for the redirect action. This is required if the type is EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA.
+        "type": "A String", # Type of the redirect action. Possible values are: - GOOGLE_RECAPTCHA: redirect to reCAPTCHA for manual challenge assessment. - EXTERNAL_302: redirect to a different URL via a 302 response.
+      },
+    },
+  ],
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "shortName": "A String", # User-provided name of the organization security policy. The name should be unique in the organization in which the security policy is created. This should only be used when SecurityPolicyType is CLOUD_ARMOR. The name must be 1-63 characters long, and comply with https://www.ietf.org/rfc/rfc1035.txt. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+  "type": "A String", # The type indicates the intended use of the security policy. - CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers. - CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache. - CLOUD_ARMOR_INTERNAL_SERVICE (preview only): Cloud Armor internal service policies can be configured to filter HTTP requests targeting services managed by Traffic Director in a service mesh. They filter requests before the request is served from the application. - CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application. This field can be set only at resource creation time.
+  "userDefinedFields": [ # Definitions of user-defined fields for CLOUD_ARMOR_NETWORK policies. A user-defined field consists of up to 4 bytes extracted from a fixed offset in the packet, relative to the IPv4, IPv6, TCP, or UDP header, with an optional mask to select certain bits. Rules may then specify matching values for these fields. Example: userDefinedFields: - name: "ipv4_fragment_offset" base: IPV4 offset: 6 size: 2 mask: "0x1fff"
+    {
+      "base": "A String", # The base relative to which 'offset' is measured. Possible values are: - IPV4: Points to the beginning of the IPv4 header. - IPV6: Points to the beginning of the IPv6 header. - TCP: Points to the beginning of the TCP header, skipping over any IPv4 options or IPv6 extension headers. Not present for non-first fragments. - UDP: Points to the beginning of the UDP header, skipping over any IPv4 options or IPv6 extension headers. Not present for non-first fragments. required
+      "mask": "A String", # If specified, apply this mask (bitwise AND) to the field to ignore bits before matching. Encoded as a hexadecimal number (starting with "0x"). The last byte of the field (in network byte order) corresponds to the least significant byte of the mask.
+      "name": "A String", # The name of this field. Must be unique within the policy.
+      "offset": 42, # Offset of the first byte of the field (in network byte order) relative to 'base'.
+      "size": 42, # Size of the field in bytes. Valid values: 1-4.
+    },
+  ],
+}
+
+ +
+ getAssociation(securityPolicy, name=None, x__xgafv=None) + 
Gets an association with the specified name. Use of this API to read firewall policies is deprecated. Use firewallPolicies.getAssociation instead if possible.
+
+Args:
+  securityPolicy: string, Name of the security policy to which the queried rule belongs. (required)
+  name: string, The name of the association to get from the security policy.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "attachmentId": "A String", # The resource that the security policy is attached to.
+  "displayName": "A String", # [Output Only] The display name of the security policy of the association.
+  "excludedFolders": [ # A list of folders to exclude from the security policy.
+    "A String",
+  ],
+  "excludedProjects": [ # A list of projects to exclude from the security policy.
+    "A String",
+  ],
+  "name": "A String", # The name for an association.
+  "securityPolicyId": "A String", # [Output Only] The security policy ID of the association.
+  "shortName": "A String", # [Output Only] The short name of the security policy of the association.
+}
+
+ +
+ getRule(securityPolicy, priority=None, x__xgafv=None) + 
Gets a rule at the specified priority. Use of this API to read firewall policies is deprecated. Use firewallPolicies.getRule instead.
+
+Args:
+  securityPolicy: string, Name of the security policy to which the queried rule belongs. (required)
+  priority: integer, The priority of the rule to get from the security policy.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).
+  "action": "A String", # The Action to perform when the rule is matched. The following are the valid actions: - allow: allow access to target. - deny(STATUS): deny access to target, returns the HTTP response code specified. Valid values for `STATUS` are 403, 404, and 502. - rate_based_ban: limit client traffic to the configured threshold and ban the client if the traffic exceeds the threshold. Configure parameters for this action in RateLimitOptions. Requires rate_limit_options to be set. - redirect: redirect to a different target. This can either be an internal reCAPTCHA redirect, or an external URL-based redirect via a 302 response. Parameters for this action can be configured via redirectOptions. This action is only supported in Global Security Policies of type CLOUD_ARMOR. - throttle: limit client traffic to the configured threshold. Configure parameters for this action in rateLimitOptions. Requires rate_limit_options to be set for this. - fairshare (preview only): when traffic reaches the threshold limit, requests from the clients matching this rule begin to be rate-limited using the Fair Share algorithm. This action is only allowed in security policies of type `CLOUD_ARMOR_INTERNAL_SERVICE`.
+  "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+  "headerAction": { # Optional, additional actions that are performed on headers. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
+    "requestHeadersToAdds": [ # The list of request headers to add or overwrite if they're already present.
+      {
+        "headerName": "A String", # The name of the header to set.
+        "headerValue": "A String", # The value to set the named header to.
+      },
+    ],
+  },
+  "kind": "compute#securityPolicyRule", # [Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules
+  "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
+    "config": { # The configuration options available when specifying versioned_expr. This field must be specified if versioned_expr is specified and cannot be specified if versioned_expr is not specified.
+      "srcIpRanges": [ # CIDR IP address range. Maximum number of src_ip_ranges allowed is 10.
+        "A String",
+      ],
+    },
+    "expr": { # 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. # User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header. Expressions containing `evaluateThreatIntelligence` require a Cloud Armor Enterprise subscription and are not supported in Edge Policies nor in Regional Policies. Expressions containing `evaluatePreconfiguredExpr('sourceiplist-*')` require a Cloud Armor Enterprise subscription and are only supported in Global Security 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.
+    },
+    "exprOptions": { # The configuration options available when specifying a user defined CEVAL expression (i.e., 'expr').
+      "recaptchaOptions": { # reCAPTCHA configuration options to be applied for the rule. If the rule does not evaluate reCAPTCHA tokens, this field has no effect.
+        "actionTokenSiteKeys": [ # A list of site keys to be used during the validation of reCAPTCHA action-tokens. The provided site keys need to be created from reCAPTCHA API under the same project where the security policy is created.
+          "A String",
+        ],
+        "sessionTokenSiteKeys": [ # A list of site keys to be used during the validation of reCAPTCHA session-tokens. The provided site keys need to be created from reCAPTCHA API under the same project where the security policy is created.
+          "A String",
+        ],
+      },
+    },
+    "versionedExpr": "A String", # Preconfigured versioned expression. If this field is specified, config must also be specified. Available preconfigured expressions along with their requirements are: SRC_IPS_V1 - must specify the corresponding src_ip_range field in config.
+  },
+  "networkMatch": { # Represents a match condition that incoming network traffic is evaluated against. # A match condition that incoming packets are evaluated against for CLOUD_ARMOR_NETWORK security policies. If it matches, the corresponding 'action' is enforced. The match criteria for a rule consists of built-in match fields (like 'srcIpRanges') and potentially multiple user-defined match fields ('userDefinedFields'). Field values may be extracted directly from the packet or derived from it (e.g. 'srcRegionCodes'). Some fields may not be present in every packet (e.g. 'srcPorts'). A user-defined field is only present if the base header is found in the packet and the entire field is in bounds. Each match field may specify which values can match it, listing one or more ranges, prefixes, or exact values that are considered a match for the field. A field value must be present in order to match a specified match field. If no match values are specified for a match field, then any field value is considered to match it, and it's not required to be present. For strings specifying '*' is also equivalent to match all. For a packet to match a rule, all specified match fields must match the corresponding field values derived from the packet. Example: networkMatch: srcIpRanges: - "192.0.2.0/24" - "198.51.100.0/24" userDefinedFields: - name: "ipv4_fragment_offset" values: - "1-0x1fff" The above match condition matches packets with a source IP in 192.0.2.0/24 or 198.51.100.0/24 and a user-defined field named "ipv4_fragment_offset" with a value between 1 and 0x1fff inclusive.
+    "destIpRanges": [ # Destination IPv4/IPv6 addresses or CIDR prefixes, in standard text format.
+      "A String",
+    ],
+    "destPorts": [ # Destination port numbers for TCP/UDP/SCTP. Each element can be a 16-bit unsigned decimal number (e.g. "80") or range (e.g. "0-1023").
+      "A String",
+    ],
+    "ipProtocols": [ # IPv4 protocol / IPv6 next header (after extension headers). Each element can be an 8-bit unsigned decimal number (e.g. "6"), range (e.g. "253-254"), or one of the following protocol names: "tcp", "udp", "icmp", "esp", "ah", "ipip", or "sctp".
+      "A String",
+    ],
+    "srcAsns": [ # BGP Autonomous System Number associated with the source IP address.
+      42,
+    ],
+    "srcIpRanges": [ # Source IPv4/IPv6 addresses or CIDR prefixes, in standard text format.
+      "A String",
+    ],
+    "srcPorts": [ # Source port numbers for TCP/UDP/SCTP. Each element can be a 16-bit unsigned decimal number (e.g. "80") or range (e.g. "0-1023").
+      "A String",
+    ],
+    "srcRegionCodes": [ # Two-letter ISO 3166-1 alpha-2 country code associated with the source IP address.
+      "A String",
+    ],
+    "userDefinedFields": [ # User-defined fields. Each element names a defined field and lists the matching values for that field.
+      {
+        "name": "A String", # Name of the user-defined field, as given in the definition.
+        "values": [ # Matching values of the field. Each element can be a 32-bit unsigned decimal or hexadecimal (starting with "0x") number (e.g. "64") or range (e.g. "0x400-0x7ff").
+          "A String",
+        ],
+      },
+    ],
+  },
+  "preconfiguredWafConfig": { # Preconfigured WAF configuration to be applied for the rule. If the rule does not evaluate preconfigured WAF rules, i.e., if evaluatePreconfiguredWaf() is not used, this field will have no effect.
+    "exclusions": [ # A list of exclusions to apply during preconfigured WAF evaluation.
+      {
+        "requestCookiesToExclude": [ # A list of request cookie names whose value will be excluded from inspection during preconfigured WAF evaluation.
+          {
+            "op": "A String", # The match operator for the field.
+            "val": "A String", # The value of the field.
+          },
+        ],
+        "requestHeadersToExclude": [ # A list of request header names whose value will be excluded from inspection during preconfigured WAF evaluation.
+          {
+            "op": "A String", # The match operator for the field.
+            "val": "A String", # The value of the field.
+          },
+        ],
+        "requestQueryParamsToExclude": [ # A list of request query parameter names whose value will be excluded from inspection during preconfigured WAF evaluation. Note that the parameter can be in the query string or in the POST body.
+          {
+            "op": "A String", # The match operator for the field.
+            "val": "A String", # The value of the field.
+          },
+        ],
+        "requestUrisToExclude": [ # A list of request URIs from the request line to be excluded from inspection during preconfigured WAF evaluation. When specifying this field, the query or fragment part should be excluded.
+          {
+            "op": "A String", # The match operator for the field.
+            "val": "A String", # The value of the field.
+          },
+        ],
+        "targetRuleIds": [ # A list of target rule IDs under the WAF rule set to apply the preconfigured WAF exclusion. If omitted, it refers to all the rule IDs under the WAF rule set.
+          "A String",
+        ],
+        "targetRuleSet": "A String", # Target WAF rule set to apply the preconfigured WAF exclusion.
+      },
+    ],
+  },
+  "preview": True or False, # If set to true, the specified action is not enforced.
+  "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority.
+  "rateLimitOptions": { # Must be specified if the action is "rate_based_ban" or "throttle" or "fairshare". Cannot be specified for any other actions.
+    "banDurationSec": 42, # Can only be specified if the action for the rule is "rate_based_ban". If specified, determines the time (in seconds) the traffic will continue to be banned by the rate limit after the rate falls below the threshold.
+    "banThreshold": { # Can only be specified if the action for the rule is "rate_based_ban". If specified, the key will be banned for the configured 'ban_duration_sec' when the number of requests that exceed the 'rate_limit_threshold' also exceed this 'ban_threshold'.
+      "count": 42, # Number of HTTP(S) requests for calculating the threshold.
+      "intervalSec": 42, # Interval over which the threshold is computed.
+    },
+    "conformAction": "A String", # Action to take for requests that are under the configured rate limit threshold. Valid option is "allow" only.
+    "enforceOnKey": "A String", # Determines the key to enforce the rate_limit_threshold on. Possible values are: - ALL: A single rate limit threshold is applied to all the requests matching this rule. This is the default value if "enforceOnKey" is not configured. - IP: The source IP address of the request is the key. Each IP has this limit enforced separately. - HTTP_HEADER: The value of the HTTP header whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to ALL. - XFF_IP: The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type IP. - HTTP_COOKIE: The value of the HTTP cookie whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to ALL. - HTTP_PATH: The URL path of the HTTP request. The key value is truncated to the first 128 bytes. - SNI: Server name indication in the TLS session of the HTTPS request. The key value is truncated to the first 128 bytes. The key type defaults to ALL on a HTTP session. - REGION_CODE: The country/region from which the request originates. - TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL. - USER_IP: The IP address of the originating client, which is resolved based on "userIpRequestHeaders" configured with the security policy. If there is no "userIpRequestHeaders" configuration or an IP address cannot be resolved from it, the key type defaults to IP. - TLS_JA4_FINGERPRINT: JA4 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL. For "fairshare" action, this value is limited to ALL i.e. a single rate limit threshold is enforced for all the requests matching the rule.
+    "enforceOnKeyConfigs": [ # If specified, any combination of values of enforce_on_key_type/enforce_on_key_name is treated as the key on which ratelimit threshold/action is enforced. You can specify up to 3 enforce_on_key_configs. If enforce_on_key_configs is specified, enforce_on_key must not be specified.
+      {
+        "enforceOnKeyName": "A String", # Rate limit key name applicable only for the following key types: HTTP_HEADER -- Name of the HTTP header whose value is taken as the key value. HTTP_COOKIE -- Name of the HTTP cookie whose value is taken as the key value.
+        "enforceOnKeyType": "A String", # Determines the key to enforce the rate_limit_threshold on. Possible values are: - ALL: A single rate limit threshold is applied to all the requests matching this rule. This is the default value if "enforceOnKeyConfigs" is not configured. - IP: The source IP address of the request is the key. Each IP has this limit enforced separately. - HTTP_HEADER: The value of the HTTP header whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to ALL. - XFF_IP: The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type IP. - HTTP_COOKIE: The value of the HTTP cookie whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to ALL. - HTTP_PATH: The URL path of the HTTP request. The key value is truncated to the first 128 bytes. - SNI: Server name indication in the TLS session of the HTTPS request. The key value is truncated to the first 128 bytes. The key type defaults to ALL on a HTTP session. - REGION_CODE: The country/region from which the request originates. - TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL. - USER_IP: The IP address of the originating client, which is resolved based on "userIpRequestHeaders" configured with the security policy. If there is no "userIpRequestHeaders" configuration or an IP address cannot be resolved from it, the key type defaults to IP. - TLS_JA4_FINGERPRINT: JA4 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL.
+      },
+    ],
+    "enforceOnKeyName": "A String", # Rate limit key name applicable only for the following key types: HTTP_HEADER -- Name of the HTTP header whose value is taken as the key value. HTTP_COOKIE -- Name of the HTTP cookie whose value is taken as the key value.
+    "exceedAction": "A String", # Action to take for requests that are above the configured rate limit threshold, to either deny with a specified HTTP response code, or redirect to a different endpoint. Valid options are `deny(STATUS)`, where valid values for `STATUS` are 403, 404, 429, and 502, and `redirect`, where the redirect parameters come from `exceedRedirectOptions` below. The `redirect` action is only supported in Global Security Policies of type CLOUD_ARMOR.
+    "exceedRedirectOptions": { # Parameters defining the redirect action that is used as the exceed action. Cannot be specified if the exceed action is not redirect. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
+      "target": "A String", # Target for the redirect action. This is required if the type is EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA.
+      "type": "A String", # Type of the redirect action. Possible values are: - GOOGLE_RECAPTCHA: redirect to reCAPTCHA for manual challenge assessment. - EXTERNAL_302: redirect to a different URL via a 302 response.
+    },
+    "rateLimitThreshold": { # Threshold at which to begin ratelimiting.
+      "count": 42, # Number of HTTP(S) requests for calculating the threshold.
+      "intervalSec": 42, # Interval over which the threshold is computed.
+    },
+  },
+  "redirectOptions": { # Parameters defining the redirect action. Cannot be specified for any other actions. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
+    "target": "A String", # Target for the redirect action. This is required if the type is EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA.
+    "type": "A String", # Type of the redirect action. Possible values are: - GOOGLE_RECAPTCHA: redirect to reCAPTCHA for manual challenge assessment. - EXTERNAL_302: redirect to a different URL via a 302 response.
+  },
+}
+
+ +
+ insert(body=None, parentId=None, requestId=None, x__xgafv=None) + 
Creates a new policy in the specified project using the data included in the request. Use of this API to insert firewall policies is deprecated. Use firewallPolicies.insert instead.
+
+Args:
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a Google Cloud Armor security policy resource. Only external backend services that use load balancers can reference a security policy. For more information, see Google Cloud Armor security policy overview.
+  "adaptiveProtectionConfig": { # Configuration options for Cloud Armor Adaptive Protection (CAAP).
+    "layer7DdosDefenseConfig": { # Configuration options for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR. # If set to true, enables Cloud Armor Machine Learning.
+      "enable": True or False, # If set to true, enables CAAP for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
+      "ruleVisibility": "A String", # Rule visibility can be one of the following: STANDARD - opaque rules. (default) PREMIUM - transparent rules. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
+      "thresholdConfigs": [ # Configuration options for layer7 adaptive protection for various customizable thresholds.
+        {
+          "autoDeployConfidenceThreshold": 3.14,
+          "autoDeployExpirationSec": 42,
+          "autoDeployImpactedBaselineThreshold": 3.14,
+          "autoDeployLoadThreshold": 3.14,
+          "detectionAbsoluteQps": 3.14,
+          "detectionLoadThreshold": 3.14,
+          "detectionRelativeToBaselineQps": 3.14,
+          "name": "A String", # The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the security policy.
+          "trafficGranularityConfigs": [ # Configuration options for enabling Adaptive Protection to operate on specified granular traffic units.
+            { # Configurations to specifc granular traffic units processed by Adaptive Protection.
+              "enableEachUniqueValue": True or False, # If enabled, traffic matching each unique value for the specified type constitutes a separate traffic unit. It can only be set to true if `value` is empty.
+              "type": "A String", # Type of this configuration.
+              "value": "A String", # Requests that match this value constitute a granular traffic unit.
+            },
+          ],
+        },
+      ],
+    },
+  },
+  "advancedOptionsConfig": {
+    "jsonCustomConfig": { # Custom configuration to apply the JSON parsing. Only applicable when json_parsing is set to STANDARD.
+      "contentTypes": [ # A list of custom Content-Type header values to apply the JSON parsing. As per RFC 1341, a Content-Type header value has the following format: Content-Type := type "/" subtype *[";" parameter] When configuring a custom Content-Type header value, only the type/subtype needs to be specified, and the parameters should be excluded.
+        "A String",
+      ],
+    },
+    "jsonParsing": "A String",
+    "logLevel": "A String",
+    "userIpRequestHeaders": [ # An optional list of case-insensitive request header names to use for resolving the callers client IP address.
+      "A String",
+    ],
+  },
+  "associations": [ # A list of associations that belong to this policy.
+    {
+      "attachmentId": "A String", # The resource that the security policy is attached to.
+      "displayName": "A String", # [Output Only] The display name of the security policy of the association.
+      "excludedFolders": [ # A list of folders to exclude from the security policy.
+        "A String",
+      ],
+      "excludedProjects": [ # A list of projects to exclude from the security policy.
+        "A String",
+      ],
+      "name": "A String", # The name for an association.
+      "securityPolicyId": "A String", # [Output Only] The security policy ID of the association.
+      "shortName": "A String", # [Output Only] The short name of the security policy of the association.
+    },
+  ],
+  "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+  "ddosProtectionConfig": {
+    "ddosProtection": "A String",
+  },
+  "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+  "fingerprint": "A String", # Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the security policy.
+  "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+  "kind": "compute#securityPolicy", # [Output only] Type of the resource. Always compute#securityPolicyfor security policies
+  "labelFingerprint": "A String", # A fingerprint for the labels being applied to this security policy, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the security policy.
+  "labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
+    "a_key": "A String",
+  },
+  "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 with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+  "recaptchaOptionsConfig": {
+    "redirectSiteKey": "A String", # An optional field to supply a reCAPTCHA site key to be used for all the rules using the redirect action with the type of GOOGLE_RECAPTCHA under the security policy. The specified site key needs to be created from the reCAPTCHA API. The user is responsible for the validity of the specified site key. If not specified, a Google-managed site key is used. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
+  },
+  "region": "A String", # [Output Only] URL of the region where the regional security policy resides. This field is not applicable to global security policies.
+  "rules": [ # A list of rules that belong to this policy. There must always be a default rule which is a rule with priority 2147483647 and match all condition (for the match condition this means match "*" for srcIpRanges and for the networkMatch condition every field must be either match "*" or not set). If no rules are provided when creating a security policy, a default rule with action "allow" will be added.
+    { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).
+      "action": "A String", # The Action to perform when the rule is matched. The following are the valid actions: - allow: allow access to target. - deny(STATUS): deny access to target, returns the HTTP response code specified. Valid values for `STATUS` are 403, 404, and 502. - rate_based_ban: limit client traffic to the configured threshold and ban the client if the traffic exceeds the threshold. Configure parameters for this action in RateLimitOptions. Requires rate_limit_options to be set. - redirect: redirect to a different target. This can either be an internal reCAPTCHA redirect, or an external URL-based redirect via a 302 response. Parameters for this action can be configured via redirectOptions. This action is only supported in Global Security Policies of type CLOUD_ARMOR. - throttle: limit client traffic to the configured threshold. Configure parameters for this action in rateLimitOptions. Requires rate_limit_options to be set for this. - fairshare (preview only): when traffic reaches the threshold limit, requests from the clients matching this rule begin to be rate-limited using the Fair Share algorithm. This action is only allowed in security policies of type `CLOUD_ARMOR_INTERNAL_SERVICE`.
+      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+      "headerAction": { # Optional, additional actions that are performed on headers. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
+        "requestHeadersToAdds": [ # The list of request headers to add or overwrite if they're already present.
+          {
+            "headerName": "A String", # The name of the header to set.
+            "headerValue": "A String", # The value to set the named header to.
+          },
+        ],
+      },
+      "kind": "compute#securityPolicyRule", # [Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules
+      "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
+        "config": { # The configuration options available when specifying versioned_expr. This field must be specified if versioned_expr is specified and cannot be specified if versioned_expr is not specified.
+          "srcIpRanges": [ # CIDR IP address range. Maximum number of src_ip_ranges allowed is 10.
+            "A String",
+          ],
+        },
+        "expr": { # 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. # User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header. Expressions containing `evaluateThreatIntelligence` require a Cloud Armor Enterprise subscription and are not supported in Edge Policies nor in Regional Policies. Expressions containing `evaluatePreconfiguredExpr('sourceiplist-*')` require a Cloud Armor Enterprise subscription and are only supported in Global Security 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.
+        },
+        "exprOptions": { # The configuration options available when specifying a user defined CEVAL expression (i.e., 'expr').
+          "recaptchaOptions": { # reCAPTCHA configuration options to be applied for the rule. If the rule does not evaluate reCAPTCHA tokens, this field has no effect.
+            "actionTokenSiteKeys": [ # A list of site keys to be used during the validation of reCAPTCHA action-tokens. The provided site keys need to be created from reCAPTCHA API under the same project where the security policy is created.
+              "A String",
+            ],
+            "sessionTokenSiteKeys": [ # A list of site keys to be used during the validation of reCAPTCHA session-tokens. The provided site keys need to be created from reCAPTCHA API under the same project where the security policy is created.
+              "A String",
+            ],
+          },
+        },
+        "versionedExpr": "A String", # Preconfigured versioned expression. If this field is specified, config must also be specified. Available preconfigured expressions along with their requirements are: SRC_IPS_V1 - must specify the corresponding src_ip_range field in config.
+      },
+      "networkMatch": { # Represents a match condition that incoming network traffic is evaluated against. # A match condition that incoming packets are evaluated against for CLOUD_ARMOR_NETWORK security policies. If it matches, the corresponding 'action' is enforced. The match criteria for a rule consists of built-in match fields (like 'srcIpRanges') and potentially multiple user-defined match fields ('userDefinedFields'). Field values may be extracted directly from the packet or derived from it (e.g. 'srcRegionCodes'). Some fields may not be present in every packet (e.g. 'srcPorts'). A user-defined field is only present if the base header is found in the packet and the entire field is in bounds. Each match field may specify which values can match it, listing one or more ranges, prefixes, or exact values that are considered a match for the field. A field value must be present in order to match a specified match field. If no match values are specified for a match field, then any field value is considered to match it, and it's not required to be present. For strings specifying '*' is also equivalent to match all. For a packet to match a rule, all specified match fields must match the corresponding field values derived from the packet. Example: networkMatch: srcIpRanges: - "192.0.2.0/24" - "198.51.100.0/24" userDefinedFields: - name: "ipv4_fragment_offset" values: - "1-0x1fff" The above match condition matches packets with a source IP in 192.0.2.0/24 or 198.51.100.0/24 and a user-defined field named "ipv4_fragment_offset" with a value between 1 and 0x1fff inclusive.
+        "destIpRanges": [ # Destination IPv4/IPv6 addresses or CIDR prefixes, in standard text format.
+          "A String",
+        ],
+        "destPorts": [ # Destination port numbers for TCP/UDP/SCTP. Each element can be a 16-bit unsigned decimal number (e.g. "80") or range (e.g. "0-1023").
+          "A String",
+        ],
+        "ipProtocols": [ # IPv4 protocol / IPv6 next header (after extension headers). Each element can be an 8-bit unsigned decimal number (e.g. "6"), range (e.g. "253-254"), or one of the following protocol names: "tcp", "udp", "icmp", "esp", "ah", "ipip", or "sctp".
+          "A String",
+        ],
+        "srcAsns": [ # BGP Autonomous System Number associated with the source IP address.
+          42,
+        ],
+        "srcIpRanges": [ # Source IPv4/IPv6 addresses or CIDR prefixes, in standard text format.
+          "A String",
+        ],
+        "srcPorts": [ # Source port numbers for TCP/UDP/SCTP. Each element can be a 16-bit unsigned decimal number (e.g. "80") or range (e.g. "0-1023").
+          "A String",
+        ],
+        "srcRegionCodes": [ # Two-letter ISO 3166-1 alpha-2 country code associated with the source IP address.
+          "A String",
+        ],
+        "userDefinedFields": [ # User-defined fields. Each element names a defined field and lists the matching values for that field.
+          {
+            "name": "A String", # Name of the user-defined field, as given in the definition.
+            "values": [ # Matching values of the field. Each element can be a 32-bit unsigned decimal or hexadecimal (starting with "0x") number (e.g. "64") or range (e.g. "0x400-0x7ff").
+              "A String",
+            ],
+          },
+        ],
+      },
+      "preconfiguredWafConfig": { # Preconfigured WAF configuration to be applied for the rule. If the rule does not evaluate preconfigured WAF rules, i.e., if evaluatePreconfiguredWaf() is not used, this field will have no effect.
+        "exclusions": [ # A list of exclusions to apply during preconfigured WAF evaluation.
+          {
+            "requestCookiesToExclude": [ # A list of request cookie names whose value will be excluded from inspection during preconfigured WAF evaluation.
+              {
+                "op": "A String", # The match operator for the field.
+                "val": "A String", # The value of the field.
+              },
+            ],
+            "requestHeadersToExclude": [ # A list of request header names whose value will be excluded from inspection during preconfigured WAF evaluation.
+              {
+                "op": "A String", # The match operator for the field.
+                "val": "A String", # The value of the field.
+              },
+            ],
+            "requestQueryParamsToExclude": [ # A list of request query parameter names whose value will be excluded from inspection during preconfigured WAF evaluation. Note that the parameter can be in the query string or in the POST body.
+              {
+                "op": "A String", # The match operator for the field.
+                "val": "A String", # The value of the field.
+              },
+            ],
+            "requestUrisToExclude": [ # A list of request URIs from the request line to be excluded from inspection during preconfigured WAF evaluation. When specifying this field, the query or fragment part should be excluded.
+              {
+                "op": "A String", # The match operator for the field.
+                "val": "A String", # The value of the field.
+              },
+            ],
+            "targetRuleIds": [ # A list of target rule IDs under the WAF rule set to apply the preconfigured WAF exclusion. If omitted, it refers to all the rule IDs under the WAF rule set.
+              "A String",
+            ],
+            "targetRuleSet": "A String", # Target WAF rule set to apply the preconfigured WAF exclusion.
+          },
+        ],
+      },
+      "preview": True or False, # If set to true, the specified action is not enforced.
+      "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority.
+      "rateLimitOptions": { # Must be specified if the action is "rate_based_ban" or "throttle" or "fairshare". Cannot be specified for any other actions.
+        "banDurationSec": 42, # Can only be specified if the action for the rule is "rate_based_ban". If specified, determines the time (in seconds) the traffic will continue to be banned by the rate limit after the rate falls below the threshold.
+        "banThreshold": { # Can only be specified if the action for the rule is "rate_based_ban". If specified, the key will be banned for the configured 'ban_duration_sec' when the number of requests that exceed the 'rate_limit_threshold' also exceed this 'ban_threshold'.
+          "count": 42, # Number of HTTP(S) requests for calculating the threshold.
+          "intervalSec": 42, # Interval over which the threshold is computed.
+        },
+        "conformAction": "A String", # Action to take for requests that are under the configured rate limit threshold. Valid option is "allow" only.
+        "enforceOnKey": "A String", # Determines the key to enforce the rate_limit_threshold on. Possible values are: - ALL: A single rate limit threshold is applied to all the requests matching this rule. This is the default value if "enforceOnKey" is not configured. - IP: The source IP address of the request is the key. Each IP has this limit enforced separately. - HTTP_HEADER: The value of the HTTP header whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to ALL. - XFF_IP: The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type IP. - HTTP_COOKIE: The value of the HTTP cookie whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to ALL. - HTTP_PATH: The URL path of the HTTP request. The key value is truncated to the first 128 bytes. - SNI: Server name indication in the TLS session of the HTTPS request. The key value is truncated to the first 128 bytes. The key type defaults to ALL on a HTTP session. - REGION_CODE: The country/region from which the request originates. - TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL. - USER_IP: The IP address of the originating client, which is resolved based on "userIpRequestHeaders" configured with the security policy. If there is no "userIpRequestHeaders" configuration or an IP address cannot be resolved from it, the key type defaults to IP. - TLS_JA4_FINGERPRINT: JA4 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL. For "fairshare" action, this value is limited to ALL i.e. a single rate limit threshold is enforced for all the requests matching the rule.
+        "enforceOnKeyConfigs": [ # If specified, any combination of values of enforce_on_key_type/enforce_on_key_name is treated as the key on which ratelimit threshold/action is enforced. You can specify up to 3 enforce_on_key_configs. If enforce_on_key_configs is specified, enforce_on_key must not be specified.
+          {
+            "enforceOnKeyName": "A String", # Rate limit key name applicable only for the following key types: HTTP_HEADER -- Name of the HTTP header whose value is taken as the key value. HTTP_COOKIE -- Name of the HTTP cookie whose value is taken as the key value.
+            "enforceOnKeyType": "A String", # Determines the key to enforce the rate_limit_threshold on. Possible values are: - ALL: A single rate limit threshold is applied to all the requests matching this rule. This is the default value if "enforceOnKeyConfigs" is not configured. - IP: The source IP address of the request is the key. Each IP has this limit enforced separately. - HTTP_HEADER: The value of the HTTP header whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to ALL. - XFF_IP: The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type IP. - HTTP_COOKIE: The value of the HTTP cookie whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to ALL. - HTTP_PATH: The URL path of the HTTP request. The key value is truncated to the first 128 bytes. - SNI: Server name indication in the TLS session of the HTTPS request. The key value is truncated to the first 128 bytes. The key type defaults to ALL on a HTTP session. - REGION_CODE: The country/region from which the request originates. - TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL. - USER_IP: The IP address of the originating client, which is resolved based on "userIpRequestHeaders" configured with the security policy. If there is no "userIpRequestHeaders" configuration or an IP address cannot be resolved from it, the key type defaults to IP. - TLS_JA4_FINGERPRINT: JA4 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL.
+          },
+        ],
+        "enforceOnKeyName": "A String", # Rate limit key name applicable only for the following key types: HTTP_HEADER -- Name of the HTTP header whose value is taken as the key value. HTTP_COOKIE -- Name of the HTTP cookie whose value is taken as the key value.
+        "exceedAction": "A String", # Action to take for requests that are above the configured rate limit threshold, to either deny with a specified HTTP response code, or redirect to a different endpoint. Valid options are `deny(STATUS)`, where valid values for `STATUS` are 403, 404, 429, and 502, and `redirect`, where the redirect parameters come from `exceedRedirectOptions` below. The `redirect` action is only supported in Global Security Policies of type CLOUD_ARMOR.
+        "exceedRedirectOptions": { # Parameters defining the redirect action that is used as the exceed action. Cannot be specified if the exceed action is not redirect. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
+          "target": "A String", # Target for the redirect action. This is required if the type is EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA.
+          "type": "A String", # Type of the redirect action. Possible values are: - GOOGLE_RECAPTCHA: redirect to reCAPTCHA for manual challenge assessment. - EXTERNAL_302: redirect to a different URL via a 302 response.
+        },
+        "rateLimitThreshold": { # Threshold at which to begin ratelimiting.
+          "count": 42, # Number of HTTP(S) requests for calculating the threshold.
+          "intervalSec": 42, # Interval over which the threshold is computed.
+        },
+      },
+      "redirectOptions": { # Parameters defining the redirect action. Cannot be specified for any other actions. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
+        "target": "A String", # Target for the redirect action. This is required if the type is EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA.
+        "type": "A String", # Type of the redirect action. Possible values are: - GOOGLE_RECAPTCHA: redirect to reCAPTCHA for manual challenge assessment. - EXTERNAL_302: redirect to a different URL via a 302 response.
+      },
+    },
+  ],
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "shortName": "A String", # User-provided name of the organization security policy. The name should be unique in the organization in which the security policy is created. This should only be used when SecurityPolicyType is CLOUD_ARMOR. The name must be 1-63 characters long, and comply with https://www.ietf.org/rfc/rfc1035.txt. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+  "type": "A String", # The type indicates the intended use of the security policy. - CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers. - CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache. - CLOUD_ARMOR_INTERNAL_SERVICE (preview only): Cloud Armor internal service policies can be configured to filter HTTP requests targeting services managed by Traffic Director in a service mesh. They filter requests before the request is served from the application. - CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application. This field can be set only at resource creation time.
+  "userDefinedFields": [ # Definitions of user-defined fields for CLOUD_ARMOR_NETWORK policies. A user-defined field consists of up to 4 bytes extracted from a fixed offset in the packet, relative to the IPv4, IPv6, TCP, or UDP header, with an optional mask to select certain bits. Rules may then specify matching values for these fields. Example: userDefinedFields: - name: "ipv4_fragment_offset" base: IPV4 offset: 6 size: 2 mask: "0x1fff"
+    {
+      "base": "A String", # The base relative to which 'offset' is measured. Possible values are: - IPV4: Points to the beginning of the IPv4 header. - IPV6: Points to the beginning of the IPv6 header. - TCP: Points to the beginning of the TCP header, skipping over any IPv4 options or IPv6 extension headers. Not present for non-first fragments. - UDP: Points to the beginning of the UDP header, skipping over any IPv4 options or IPv6 extension headers. Not present for non-first fragments. required
+      "mask": "A String", # If specified, apply this mask (bitwise AND) to the field to ignore bits before matching. Encoded as a hexadecimal number (starting with "0x"). The last byte of the field (in network byte order) corresponds to the least significant byte of the mask.
+      "name": "A String", # The name of this field. Must be unique within the policy.
+      "offset": 42, # Offset of the first byte of the field (in network byte order) relative to 'base'.
+      "size": 42, # Size of the field in bytes. Valid values: 1-4.
+    },
+  ],
+}
+
+  parentId: string, Parent ID for this request. The ID can be either be "folders/[FOLDER_ID]" if the parent is a folder or "organizations/[ORGANIZATION_ID]" if the parent is an organization.
+  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/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling 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 in RFC3339 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 in RFC3339 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 different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be 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 in RFC3339 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(filter=None, maxResults=None, orderBy=None, pageToken=None, parentId=None, returnPartialSuccess=None, x__xgafv=None) + 
List all the policies that have been configured for the specified project. Use of this API to read firewall policies is deprecated. Use firewallPolicies.list instead.
+
+Args:
+  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 on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
+  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.
+  parentId: string, Parent ID for this request.
+  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:
+
+    {
+  "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+  "items": [ # A list of SecurityPolicy resources.
+    { # Represents a Google Cloud Armor security policy resource. Only external backend services that use load balancers can reference a security policy. For more information, see Google Cloud Armor security policy overview.
+      "adaptiveProtectionConfig": { # Configuration options for Cloud Armor Adaptive Protection (CAAP).
+        "layer7DdosDefenseConfig": { # Configuration options for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR. # If set to true, enables Cloud Armor Machine Learning.
+          "enable": True or False, # If set to true, enables CAAP for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
+          "ruleVisibility": "A String", # Rule visibility can be one of the following: STANDARD - opaque rules. (default) PREMIUM - transparent rules. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
+          "thresholdConfigs": [ # Configuration options for layer7 adaptive protection for various customizable thresholds.
+            {
+              "autoDeployConfidenceThreshold": 3.14,
+              "autoDeployExpirationSec": 42,
+              "autoDeployImpactedBaselineThreshold": 3.14,
+              "autoDeployLoadThreshold": 3.14,
+              "detectionAbsoluteQps": 3.14,
+              "detectionLoadThreshold": 3.14,
+              "detectionRelativeToBaselineQps": 3.14,
+              "name": "A String", # The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the security policy.
+              "trafficGranularityConfigs": [ # Configuration options for enabling Adaptive Protection to operate on specified granular traffic units.
+                { # Configurations to specifc granular traffic units processed by Adaptive Protection.
+                  "enableEachUniqueValue": True or False, # If enabled, traffic matching each unique value for the specified type constitutes a separate traffic unit. It can only be set to true if `value` is empty.
+                  "type": "A String", # Type of this configuration.
+                  "value": "A String", # Requests that match this value constitute a granular traffic unit.
+                },
+              ],
+            },
+          ],
+        },
+      },
+      "advancedOptionsConfig": {
+        "jsonCustomConfig": { # Custom configuration to apply the JSON parsing. Only applicable when json_parsing is set to STANDARD.
+          "contentTypes": [ # A list of custom Content-Type header values to apply the JSON parsing. As per RFC 1341, a Content-Type header value has the following format: Content-Type := type "/" subtype *[";" parameter] When configuring a custom Content-Type header value, only the type/subtype needs to be specified, and the parameters should be excluded.
+            "A String",
+          ],
+        },
+        "jsonParsing": "A String",
+        "logLevel": "A String",
+        "userIpRequestHeaders": [ # An optional list of case-insensitive request header names to use for resolving the callers client IP address.
+          "A String",
+        ],
+      },
+      "associations": [ # A list of associations that belong to this policy.
+        {
+          "attachmentId": "A String", # The resource that the security policy is attached to.
+          "displayName": "A String", # [Output Only] The display name of the security policy of the association.
+          "excludedFolders": [ # A list of folders to exclude from the security policy.
+            "A String",
+          ],
+          "excludedProjects": [ # A list of projects to exclude from the security policy.
+            "A String",
+          ],
+          "name": "A String", # The name for an association.
+          "securityPolicyId": "A String", # [Output Only] The security policy ID of the association.
+          "shortName": "A String", # [Output Only] The short name of the security policy of the association.
+        },
+      ],
+      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+      "ddosProtectionConfig": {
+        "ddosProtection": "A String",
+      },
+      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+      "fingerprint": "A String", # Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the security policy.
+      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+      "kind": "compute#securityPolicy", # [Output only] Type of the resource. Always compute#securityPolicyfor security policies
+      "labelFingerprint": "A String", # A fingerprint for the labels being applied to this security policy, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the security policy.
+      "labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
+        "a_key": "A String",
+      },
+      "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 with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+      "recaptchaOptionsConfig": {
+        "redirectSiteKey": "A String", # An optional field to supply a reCAPTCHA site key to be used for all the rules using the redirect action with the type of GOOGLE_RECAPTCHA under the security policy. The specified site key needs to be created from the reCAPTCHA API. The user is responsible for the validity of the specified site key. If not specified, a Google-managed site key is used. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
+      },
+      "region": "A String", # [Output Only] URL of the region where the regional security policy resides. This field is not applicable to global security policies.
+      "rules": [ # A list of rules that belong to this policy. There must always be a default rule which is a rule with priority 2147483647 and match all condition (for the match condition this means match "*" for srcIpRanges and for the networkMatch condition every field must be either match "*" or not set). If no rules are provided when creating a security policy, a default rule with action "allow" will be added.
+        { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).
+          "action": "A String", # The Action to perform when the rule is matched. The following are the valid actions: - allow: allow access to target. - deny(STATUS): deny access to target, returns the HTTP response code specified. Valid values for `STATUS` are 403, 404, and 502. - rate_based_ban: limit client traffic to the configured threshold and ban the client if the traffic exceeds the threshold. Configure parameters for this action in RateLimitOptions. Requires rate_limit_options to be set. - redirect: redirect to a different target. This can either be an internal reCAPTCHA redirect, or an external URL-based redirect via a 302 response. Parameters for this action can be configured via redirectOptions. This action is only supported in Global Security Policies of type CLOUD_ARMOR. - throttle: limit client traffic to the configured threshold. Configure parameters for this action in rateLimitOptions. Requires rate_limit_options to be set for this. - fairshare (preview only): when traffic reaches the threshold limit, requests from the clients matching this rule begin to be rate-limited using the Fair Share algorithm. This action is only allowed in security policies of type `CLOUD_ARMOR_INTERNAL_SERVICE`.
+          "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+          "headerAction": { # Optional, additional actions that are performed on headers. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
+            "requestHeadersToAdds": [ # The list of request headers to add or overwrite if they're already present.
+              {
+                "headerName": "A String", # The name of the header to set.
+                "headerValue": "A String", # The value to set the named header to.
+              },
+            ],
+          },
+          "kind": "compute#securityPolicyRule", # [Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules
+          "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
+            "config": { # The configuration options available when specifying versioned_expr. This field must be specified if versioned_expr is specified and cannot be specified if versioned_expr is not specified.
+              "srcIpRanges": [ # CIDR IP address range. Maximum number of src_ip_ranges allowed is 10.
+                "A String",
+              ],
+            },
+            "expr": { # 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. # User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header. Expressions containing `evaluateThreatIntelligence` require a Cloud Armor Enterprise subscription and are not supported in Edge Policies nor in Regional Policies. Expressions containing `evaluatePreconfiguredExpr('sourceiplist-*')` require a Cloud Armor Enterprise subscription and are only supported in Global Security 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.
+            },
+            "exprOptions": { # The configuration options available when specifying a user defined CEVAL expression (i.e., 'expr').
+              "recaptchaOptions": { # reCAPTCHA configuration options to be applied for the rule. If the rule does not evaluate reCAPTCHA tokens, this field has no effect.
+                "actionTokenSiteKeys": [ # A list of site keys to be used during the validation of reCAPTCHA action-tokens. The provided site keys need to be created from reCAPTCHA API under the same project where the security policy is created.
+                  "A String",
+                ],
+                "sessionTokenSiteKeys": [ # A list of site keys to be used during the validation of reCAPTCHA session-tokens. The provided site keys need to be created from reCAPTCHA API under the same project where the security policy is created.
+                  "A String",
+                ],
+              },
+            },
+            "versionedExpr": "A String", # Preconfigured versioned expression. If this field is specified, config must also be specified. Available preconfigured expressions along with their requirements are: SRC_IPS_V1 - must specify the corresponding src_ip_range field in config.
+          },
+          "networkMatch": { # Represents a match condition that incoming network traffic is evaluated against. # A match condition that incoming packets are evaluated against for CLOUD_ARMOR_NETWORK security policies. If it matches, the corresponding 'action' is enforced. The match criteria for a rule consists of built-in match fields (like 'srcIpRanges') and potentially multiple user-defined match fields ('userDefinedFields'). Field values may be extracted directly from the packet or derived from it (e.g. 'srcRegionCodes'). Some fields may not be present in every packet (e.g. 'srcPorts'). A user-defined field is only present if the base header is found in the packet and the entire field is in bounds. Each match field may specify which values can match it, listing one or more ranges, prefixes, or exact values that are considered a match for the field. A field value must be present in order to match a specified match field. If no match values are specified for a match field, then any field value is considered to match it, and it's not required to be present. For strings specifying '*' is also equivalent to match all. For a packet to match a rule, all specified match fields must match the corresponding field values derived from the packet. Example: networkMatch: srcIpRanges: - "192.0.2.0/24" - "198.51.100.0/24" userDefinedFields: - name: "ipv4_fragment_offset" values: - "1-0x1fff" The above match condition matches packets with a source IP in 192.0.2.0/24 or 198.51.100.0/24 and a user-defined field named "ipv4_fragment_offset" with a value between 1 and 0x1fff inclusive.
+            "destIpRanges": [ # Destination IPv4/IPv6 addresses or CIDR prefixes, in standard text format.
+              "A String",
+            ],
+            "destPorts": [ # Destination port numbers for TCP/UDP/SCTP. Each element can be a 16-bit unsigned decimal number (e.g. "80") or range (e.g. "0-1023").
+              "A String",
+            ],
+            "ipProtocols": [ # IPv4 protocol / IPv6 next header (after extension headers). Each element can be an 8-bit unsigned decimal number (e.g. "6"), range (e.g. "253-254"), or one of the following protocol names: "tcp", "udp", "icmp", "esp", "ah", "ipip", or "sctp".
+              "A String",
+            ],
+            "srcAsns": [ # BGP Autonomous System Number associated with the source IP address.
+              42,
+            ],
+            "srcIpRanges": [ # Source IPv4/IPv6 addresses or CIDR prefixes, in standard text format.
+              "A String",
+            ],
+            "srcPorts": [ # Source port numbers for TCP/UDP/SCTP. Each element can be a 16-bit unsigned decimal number (e.g. "80") or range (e.g. "0-1023").
+              "A String",
+            ],
+            "srcRegionCodes": [ # Two-letter ISO 3166-1 alpha-2 country code associated with the source IP address.
+              "A String",
+            ],
+            "userDefinedFields": [ # User-defined fields. Each element names a defined field and lists the matching values for that field.
+              {
+                "name": "A String", # Name of the user-defined field, as given in the definition.
+                "values": [ # Matching values of the field. Each element can be a 32-bit unsigned decimal or hexadecimal (starting with "0x") number (e.g. "64") or range (e.g. "0x400-0x7ff").
+                  "A String",
+                ],
+              },
+            ],
+          },
+          "preconfiguredWafConfig": { # Preconfigured WAF configuration to be applied for the rule. If the rule does not evaluate preconfigured WAF rules, i.e., if evaluatePreconfiguredWaf() is not used, this field will have no effect.
+            "exclusions": [ # A list of exclusions to apply during preconfigured WAF evaluation.
+              {
+                "requestCookiesToExclude": [ # A list of request cookie names whose value will be excluded from inspection during preconfigured WAF evaluation.
+                  {
+                    "op": "A String", # The match operator for the field.
+                    "val": "A String", # The value of the field.
+                  },
+                ],
+                "requestHeadersToExclude": [ # A list of request header names whose value will be excluded from inspection during preconfigured WAF evaluation.
+                  {
+                    "op": "A String", # The match operator for the field.
+                    "val": "A String", # The value of the field.
+                  },
+                ],
+                "requestQueryParamsToExclude": [ # A list of request query parameter names whose value will be excluded from inspection during preconfigured WAF evaluation. Note that the parameter can be in the query string or in the POST body.
+                  {
+                    "op": "A String", # The match operator for the field.
+                    "val": "A String", # The value of the field.
+                  },
+                ],
+                "requestUrisToExclude": [ # A list of request URIs from the request line to be excluded from inspection during preconfigured WAF evaluation. When specifying this field, the query or fragment part should be excluded.
+                  {
+                    "op": "A String", # The match operator for the field.
+                    "val": "A String", # The value of the field.
+                  },
+                ],
+                "targetRuleIds": [ # A list of target rule IDs under the WAF rule set to apply the preconfigured WAF exclusion. If omitted, it refers to all the rule IDs under the WAF rule set.
+                  "A String",
+                ],
+                "targetRuleSet": "A String", # Target WAF rule set to apply the preconfigured WAF exclusion.
+              },
+            ],
+          },
+          "preview": True or False, # If set to true, the specified action is not enforced.
+          "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority.
+          "rateLimitOptions": { # Must be specified if the action is "rate_based_ban" or "throttle" or "fairshare". Cannot be specified for any other actions.
+            "banDurationSec": 42, # Can only be specified if the action for the rule is "rate_based_ban". If specified, determines the time (in seconds) the traffic will continue to be banned by the rate limit after the rate falls below the threshold.
+            "banThreshold": { # Can only be specified if the action for the rule is "rate_based_ban". If specified, the key will be banned for the configured 'ban_duration_sec' when the number of requests that exceed the 'rate_limit_threshold' also exceed this 'ban_threshold'.
+              "count": 42, # Number of HTTP(S) requests for calculating the threshold.
+              "intervalSec": 42, # Interval over which the threshold is computed.
+            },
+            "conformAction": "A String", # Action to take for requests that are under the configured rate limit threshold. Valid option is "allow" only.
+            "enforceOnKey": "A String", # Determines the key to enforce the rate_limit_threshold on. Possible values are: - ALL: A single rate limit threshold is applied to all the requests matching this rule. This is the default value if "enforceOnKey" is not configured. - IP: The source IP address of the request is the key. Each IP has this limit enforced separately. - HTTP_HEADER: The value of the HTTP header whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to ALL. - XFF_IP: The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type IP. - HTTP_COOKIE: The value of the HTTP cookie whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to ALL. - HTTP_PATH: The URL path of the HTTP request. The key value is truncated to the first 128 bytes. - SNI: Server name indication in the TLS session of the HTTPS request. The key value is truncated to the first 128 bytes. The key type defaults to ALL on a HTTP session. - REGION_CODE: The country/region from which the request originates. - TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL. - USER_IP: The IP address of the originating client, which is resolved based on "userIpRequestHeaders" configured with the security policy. If there is no "userIpRequestHeaders" configuration or an IP address cannot be resolved from it, the key type defaults to IP. - TLS_JA4_FINGERPRINT: JA4 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL. For "fairshare" action, this value is limited to ALL i.e. a single rate limit threshold is enforced for all the requests matching the rule.
+            "enforceOnKeyConfigs": [ # If specified, any combination of values of enforce_on_key_type/enforce_on_key_name is treated as the key on which ratelimit threshold/action is enforced. You can specify up to 3 enforce_on_key_configs. If enforce_on_key_configs is specified, enforce_on_key must not be specified.
+              {
+                "enforceOnKeyName": "A String", # Rate limit key name applicable only for the following key types: HTTP_HEADER -- Name of the HTTP header whose value is taken as the key value. HTTP_COOKIE -- Name of the HTTP cookie whose value is taken as the key value.
+                "enforceOnKeyType": "A String", # Determines the key to enforce the rate_limit_threshold on. Possible values are: - ALL: A single rate limit threshold is applied to all the requests matching this rule. This is the default value if "enforceOnKeyConfigs" is not configured. - IP: The source IP address of the request is the key. Each IP has this limit enforced separately. - HTTP_HEADER: The value of the HTTP header whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to ALL. - XFF_IP: The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type IP. - HTTP_COOKIE: The value of the HTTP cookie whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to ALL. - HTTP_PATH: The URL path of the HTTP request. The key value is truncated to the first 128 bytes. - SNI: Server name indication in the TLS session of the HTTPS request. The key value is truncated to the first 128 bytes. The key type defaults to ALL on a HTTP session. - REGION_CODE: The country/region from which the request originates. - TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL. - USER_IP: The IP address of the originating client, which is resolved based on "userIpRequestHeaders" configured with the security policy. If there is no "userIpRequestHeaders" configuration or an IP address cannot be resolved from it, the key type defaults to IP. - TLS_JA4_FINGERPRINT: JA4 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL.
+              },
+            ],
+            "enforceOnKeyName": "A String", # Rate limit key name applicable only for the following key types: HTTP_HEADER -- Name of the HTTP header whose value is taken as the key value. HTTP_COOKIE -- Name of the HTTP cookie whose value is taken as the key value.
+            "exceedAction": "A String", # Action to take for requests that are above the configured rate limit threshold, to either deny with a specified HTTP response code, or redirect to a different endpoint. Valid options are `deny(STATUS)`, where valid values for `STATUS` are 403, 404, 429, and 502, and `redirect`, where the redirect parameters come from `exceedRedirectOptions` below. The `redirect` action is only supported in Global Security Policies of type CLOUD_ARMOR.
+            "exceedRedirectOptions": { # Parameters defining the redirect action that is used as the exceed action. Cannot be specified if the exceed action is not redirect. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
+              "target": "A String", # Target for the redirect action. This is required if the type is EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA.
+              "type": "A String", # Type of the redirect action. Possible values are: - GOOGLE_RECAPTCHA: redirect to reCAPTCHA for manual challenge assessment. - EXTERNAL_302: redirect to a different URL via a 302 response.
+            },
+            "rateLimitThreshold": { # Threshold at which to begin ratelimiting.
+              "count": 42, # Number of HTTP(S) requests for calculating the threshold.
+              "intervalSec": 42, # Interval over which the threshold is computed.
+            },
+          },
+          "redirectOptions": { # Parameters defining the redirect action. Cannot be specified for any other actions. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
+            "target": "A String", # Target for the redirect action. This is required if the type is EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA.
+            "type": "A String", # Type of the redirect action. Possible values are: - GOOGLE_RECAPTCHA: redirect to reCAPTCHA for manual challenge assessment. - EXTERNAL_302: redirect to a different URL via a 302 response.
+          },
+        },
+      ],
+      "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+      "shortName": "A String", # User-provided name of the organization security policy. The name should be unique in the organization in which the security policy is created. This should only be used when SecurityPolicyType is CLOUD_ARMOR. The name must be 1-63 characters long, and comply with https://www.ietf.org/rfc/rfc1035.txt. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+      "type": "A String", # The type indicates the intended use of the security policy. - CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers. - CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache. - CLOUD_ARMOR_INTERNAL_SERVICE (preview only): Cloud Armor internal service policies can be configured to filter HTTP requests targeting services managed by Traffic Director in a service mesh. They filter requests before the request is served from the application. - CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application. This field can be set only at resource creation time.
+      "userDefinedFields": [ # Definitions of user-defined fields for CLOUD_ARMOR_NETWORK policies. A user-defined field consists of up to 4 bytes extracted from a fixed offset in the packet, relative to the IPv4, IPv6, TCP, or UDP header, with an optional mask to select certain bits. Rules may then specify matching values for these fields. Example: userDefinedFields: - name: "ipv4_fragment_offset" base: IPV4 offset: 6 size: 2 mask: "0x1fff"
+        {
+          "base": "A String", # The base relative to which 'offset' is measured. Possible values are: - IPV4: Points to the beginning of the IPv4 header. - IPV6: Points to the beginning of the IPv6 header. - TCP: Points to the beginning of the TCP header, skipping over any IPv4 options or IPv6 extension headers. Not present for non-first fragments. - UDP: Points to the beginning of the UDP header, skipping over any IPv4 options or IPv6 extension headers. Not present for non-first fragments. required
+          "mask": "A String", # If specified, apply this mask (bitwise AND) to the field to ignore bits before matching. Encoded as a hexadecimal number (starting with "0x"). The last byte of the field (in network byte order) corresponds to the least significant byte of the mask.
+          "name": "A String", # The name of this field. Must be unique within the policy.
+          "offset": 42, # Offset of the first byte of the field (in network byte order) relative to 'base'.
+          "size": 42, # Size of the field in bytes. Valid values: 1-4.
+        },
+      ],
+    },
+  ],
+  "kind": "compute#securityPolicyList", # [Output Only] Type of resource. Always compute#securityPolicyList for listsof securityPolicies
+  "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 than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+  "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.
+  },
+}
+
+ +
+ listAssociations(targetResource=None, x__xgafv=None) + 
Lists associations of a specified target, i.e., organization or folder. Use of this API to read firewall policies is deprecated. Use firewallPolicies.listAssociations instead if possible.
+
+Args:
+  targetResource: string, The target resource to list associations. It is an organization, or a folder.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "associations": [ # A list of associations.
+    {
+      "attachmentId": "A String", # The resource that the security policy is attached to.
+      "displayName": "A String", # [Output Only] The display name of the security policy of the association.
+      "excludedFolders": [ # A list of folders to exclude from the security policy.
+        "A String",
+      ],
+      "excludedProjects": [ # A list of projects to exclude from the security policy.
+        "A String",
+      ],
+      "name": "A String", # The name for an association.
+      "securityPolicyId": "A String", # [Output Only] The security policy ID of the association.
+      "shortName": "A String", # [Output Only] The short name of the security policy of the association.
+    },
+  ],
+  "kind": "compute#organizationSecurityPoliciesListAssociationsResponse", # [Output Only] Type of securityPolicy associations. Always compute#organizationSecurityPoliciesListAssociations for lists of securityPolicy associations.
+}
+
+ +
+ listPreconfiguredExpressionSets(filter=None, maxResults=None, orderBy=None, pageToken=None, parentId=None, returnPartialSuccess=None, x__xgafv=None) + 
Gets the current list of preconfigured Web Application Firewall (WAF) expressions.
+
+Args:
+  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 on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
+  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.
+  parentId: string, Parent ID for this request.
+  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:
+
+    {
+  "preconfiguredExpressionSets": {
+    "wafRules": {
+      "expressionSets": [ # List of entities that are currently supported for WAF rules.
+        {
+          "aliases": [ # A list of alternate IDs. The format should be: - E.g. XSS-stable Generic suffix like "stable" is particularly useful if a policy likes to avail newer set of expressions without having to change the policy. A given alias name can't be used for more than one entity set.
+            "A String",
+          ],
+          "expressions": [ # List of available expressions.
+            {
+              "id": "A String", # Expression ID should uniquely identify the origin of the expression. E.g. owasp-crs-v020901-id973337 identifies Owasp core rule set version 2.9.1 rule id 973337. The ID could be used to determine the individual attack definition that has been detected. It could also be used to exclude it from the policy in case of false positive. required
+              "sensitivity": 42, # The sensitivity value associated with the WAF rule ID. This corresponds to the ModSecurity paranoia level, ranging from 1 to 4. 0 is reserved for opt-in only rules.
+            },
+          ],
+          "id": "A String", # Google specified expression set ID. The format should be: - E.g. XSS-20170329 required
+        },
+      ],
+    },
+  },
+}
+
+ +
+ 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.
+
+
+ +
+ move(securityPolicy, parentId=None, requestId=None, x__xgafv=None) + 
Moves the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.move instead.
+
+Args:
+  securityPolicy: string, Name of the security policy to update. (required)
+  parentId: string, The new parent of the security policy.
+  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/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling 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 in RFC3339 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 in RFC3339 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 different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be 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 in RFC3339 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.
+}
+
+ +
+ patch(securityPolicy, body=None, requestId=None, x__xgafv=None) + 
Patches the specified policy with the data included in the request. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.patch instead.
+
+Args:
+  securityPolicy: string, Name of the security policy to update. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a Google Cloud Armor security policy resource. Only external backend services that use load balancers can reference a security policy. For more information, see Google Cloud Armor security policy overview.
+  "adaptiveProtectionConfig": { # Configuration options for Cloud Armor Adaptive Protection (CAAP).
+    "layer7DdosDefenseConfig": { # Configuration options for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR. # If set to true, enables Cloud Armor Machine Learning.
+      "enable": True or False, # If set to true, enables CAAP for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
+      "ruleVisibility": "A String", # Rule visibility can be one of the following: STANDARD - opaque rules. (default) PREMIUM - transparent rules. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
+      "thresholdConfigs": [ # Configuration options for layer7 adaptive protection for various customizable thresholds.
+        {
+          "autoDeployConfidenceThreshold": 3.14,
+          "autoDeployExpirationSec": 42,
+          "autoDeployImpactedBaselineThreshold": 3.14,
+          "autoDeployLoadThreshold": 3.14,
+          "detectionAbsoluteQps": 3.14,
+          "detectionLoadThreshold": 3.14,
+          "detectionRelativeToBaselineQps": 3.14,
+          "name": "A String", # The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the security policy.
+          "trafficGranularityConfigs": [ # Configuration options for enabling Adaptive Protection to operate on specified granular traffic units.
+            { # Configurations to specifc granular traffic units processed by Adaptive Protection.
+              "enableEachUniqueValue": True or False, # If enabled, traffic matching each unique value for the specified type constitutes a separate traffic unit. It can only be set to true if `value` is empty.
+              "type": "A String", # Type of this configuration.
+              "value": "A String", # Requests that match this value constitute a granular traffic unit.
+            },
+          ],
+        },
+      ],
+    },
+  },
+  "advancedOptionsConfig": {
+    "jsonCustomConfig": { # Custom configuration to apply the JSON parsing. Only applicable when json_parsing is set to STANDARD.
+      "contentTypes": [ # A list of custom Content-Type header values to apply the JSON parsing. As per RFC 1341, a Content-Type header value has the following format: Content-Type := type "/" subtype *[";" parameter] When configuring a custom Content-Type header value, only the type/subtype needs to be specified, and the parameters should be excluded.
+        "A String",
+      ],
+    },
+    "jsonParsing": "A String",
+    "logLevel": "A String",
+    "userIpRequestHeaders": [ # An optional list of case-insensitive request header names to use for resolving the callers client IP address.
+      "A String",
+    ],
+  },
+  "associations": [ # A list of associations that belong to this policy.
+    {
+      "attachmentId": "A String", # The resource that the security policy is attached to.
+      "displayName": "A String", # [Output Only] The display name of the security policy of the association.
+      "excludedFolders": [ # A list of folders to exclude from the security policy.
+        "A String",
+      ],
+      "excludedProjects": [ # A list of projects to exclude from the security policy.
+        "A String",
+      ],
+      "name": "A String", # The name for an association.
+      "securityPolicyId": "A String", # [Output Only] The security policy ID of the association.
+      "shortName": "A String", # [Output Only] The short name of the security policy of the association.
+    },
+  ],
+  "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+  "ddosProtectionConfig": {
+    "ddosProtection": "A String",
+  },
+  "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+  "fingerprint": "A String", # Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the security policy.
+  "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+  "kind": "compute#securityPolicy", # [Output only] Type of the resource. Always compute#securityPolicyfor security policies
+  "labelFingerprint": "A String", # A fingerprint for the labels being applied to this security policy, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the security policy.
+  "labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
+    "a_key": "A String",
+  },
+  "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 with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+  "recaptchaOptionsConfig": {
+    "redirectSiteKey": "A String", # An optional field to supply a reCAPTCHA site key to be used for all the rules using the redirect action with the type of GOOGLE_RECAPTCHA under the security policy. The specified site key needs to be created from the reCAPTCHA API. The user is responsible for the validity of the specified site key. If not specified, a Google-managed site key is used. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
+  },
+  "region": "A String", # [Output Only] URL of the region where the regional security policy resides. This field is not applicable to global security policies.
+  "rules": [ # A list of rules that belong to this policy. There must always be a default rule which is a rule with priority 2147483647 and match all condition (for the match condition this means match "*" for srcIpRanges and for the networkMatch condition every field must be either match "*" or not set). If no rules are provided when creating a security policy, a default rule with action "allow" will be added.
+    { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).
+      "action": "A String", # The Action to perform when the rule is matched. The following are the valid actions: - allow: allow access to target. - deny(STATUS): deny access to target, returns the HTTP response code specified. Valid values for `STATUS` are 403, 404, and 502. - rate_based_ban: limit client traffic to the configured threshold and ban the client if the traffic exceeds the threshold. Configure parameters for this action in RateLimitOptions. Requires rate_limit_options to be set. - redirect: redirect to a different target. This can either be an internal reCAPTCHA redirect, or an external URL-based redirect via a 302 response. Parameters for this action can be configured via redirectOptions. This action is only supported in Global Security Policies of type CLOUD_ARMOR. - throttle: limit client traffic to the configured threshold. Configure parameters for this action in rateLimitOptions. Requires rate_limit_options to be set for this. - fairshare (preview only): when traffic reaches the threshold limit, requests from the clients matching this rule begin to be rate-limited using the Fair Share algorithm. This action is only allowed in security policies of type `CLOUD_ARMOR_INTERNAL_SERVICE`.
+      "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+      "headerAction": { # Optional, additional actions that are performed on headers. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
+        "requestHeadersToAdds": [ # The list of request headers to add or overwrite if they're already present.
+          {
+            "headerName": "A String", # The name of the header to set.
+            "headerValue": "A String", # The value to set the named header to.
+          },
+        ],
+      },
+      "kind": "compute#securityPolicyRule", # [Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules
+      "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
+        "config": { # The configuration options available when specifying versioned_expr. This field must be specified if versioned_expr is specified and cannot be specified if versioned_expr is not specified.
+          "srcIpRanges": [ # CIDR IP address range. Maximum number of src_ip_ranges allowed is 10.
+            "A String",
+          ],
+        },
+        "expr": { # 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. # User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header. Expressions containing `evaluateThreatIntelligence` require a Cloud Armor Enterprise subscription and are not supported in Edge Policies nor in Regional Policies. Expressions containing `evaluatePreconfiguredExpr('sourceiplist-*')` require a Cloud Armor Enterprise subscription and are only supported in Global Security 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.
+        },
+        "exprOptions": { # The configuration options available when specifying a user defined CEVAL expression (i.e., 'expr').
+          "recaptchaOptions": { # reCAPTCHA configuration options to be applied for the rule. If the rule does not evaluate reCAPTCHA tokens, this field has no effect.
+            "actionTokenSiteKeys": [ # A list of site keys to be used during the validation of reCAPTCHA action-tokens. The provided site keys need to be created from reCAPTCHA API under the same project where the security policy is created.
+              "A String",
+            ],
+            "sessionTokenSiteKeys": [ # A list of site keys to be used during the validation of reCAPTCHA session-tokens. The provided site keys need to be created from reCAPTCHA API under the same project where the security policy is created.
+              "A String",
+            ],
+          },
+        },
+        "versionedExpr": "A String", # Preconfigured versioned expression. If this field is specified, config must also be specified. Available preconfigured expressions along with their requirements are: SRC_IPS_V1 - must specify the corresponding src_ip_range field in config.
+      },
+      "networkMatch": { # Represents a match condition that incoming network traffic is evaluated against. # A match condition that incoming packets are evaluated against for CLOUD_ARMOR_NETWORK security policies. If it matches, the corresponding 'action' is enforced. The match criteria for a rule consists of built-in match fields (like 'srcIpRanges') and potentially multiple user-defined match fields ('userDefinedFields'). Field values may be extracted directly from the packet or derived from it (e.g. 'srcRegionCodes'). Some fields may not be present in every packet (e.g. 'srcPorts'). A user-defined field is only present if the base header is found in the packet and the entire field is in bounds. Each match field may specify which values can match it, listing one or more ranges, prefixes, or exact values that are considered a match for the field. A field value must be present in order to match a specified match field. If no match values are specified for a match field, then any field value is considered to match it, and it's not required to be present. For strings specifying '*' is also equivalent to match all. For a packet to match a rule, all specified match fields must match the corresponding field values derived from the packet. Example: networkMatch: srcIpRanges: - "192.0.2.0/24" - "198.51.100.0/24" userDefinedFields: - name: "ipv4_fragment_offset" values: - "1-0x1fff" The above match condition matches packets with a source IP in 192.0.2.0/24 or 198.51.100.0/24 and a user-defined field named "ipv4_fragment_offset" with a value between 1 and 0x1fff inclusive.
+        "destIpRanges": [ # Destination IPv4/IPv6 addresses or CIDR prefixes, in standard text format.
+          "A String",
+        ],
+        "destPorts": [ # Destination port numbers for TCP/UDP/SCTP. Each element can be a 16-bit unsigned decimal number (e.g. "80") or range (e.g. "0-1023").
+          "A String",
+        ],
+        "ipProtocols": [ # IPv4 protocol / IPv6 next header (after extension headers). Each element can be an 8-bit unsigned decimal number (e.g. "6"), range (e.g. "253-254"), or one of the following protocol names: "tcp", "udp", "icmp", "esp", "ah", "ipip", or "sctp".
+          "A String",
+        ],
+        "srcAsns": [ # BGP Autonomous System Number associated with the source IP address.
+          42,
+        ],
+        "srcIpRanges": [ # Source IPv4/IPv6 addresses or CIDR prefixes, in standard text format.
+          "A String",
+        ],
+        "srcPorts": [ # Source port numbers for TCP/UDP/SCTP. Each element can be a 16-bit unsigned decimal number (e.g. "80") or range (e.g. "0-1023").
+          "A String",
+        ],
+        "srcRegionCodes": [ # Two-letter ISO 3166-1 alpha-2 country code associated with the source IP address.
+          "A String",
+        ],
+        "userDefinedFields": [ # User-defined fields. Each element names a defined field and lists the matching values for that field.
+          {
+            "name": "A String", # Name of the user-defined field, as given in the definition.
+            "values": [ # Matching values of the field. Each element can be a 32-bit unsigned decimal or hexadecimal (starting with "0x") number (e.g. "64") or range (e.g. "0x400-0x7ff").
+              "A String",
+            ],
+          },
+        ],
+      },
+      "preconfiguredWafConfig": { # Preconfigured WAF configuration to be applied for the rule. If the rule does not evaluate preconfigured WAF rules, i.e., if evaluatePreconfiguredWaf() is not used, this field will have no effect.
+        "exclusions": [ # A list of exclusions to apply during preconfigured WAF evaluation.
+          {
+            "requestCookiesToExclude": [ # A list of request cookie names whose value will be excluded from inspection during preconfigured WAF evaluation.
+              {
+                "op": "A String", # The match operator for the field.
+                "val": "A String", # The value of the field.
+              },
+            ],
+            "requestHeadersToExclude": [ # A list of request header names whose value will be excluded from inspection during preconfigured WAF evaluation.
+              {
+                "op": "A String", # The match operator for the field.
+                "val": "A String", # The value of the field.
+              },
+            ],
+            "requestQueryParamsToExclude": [ # A list of request query parameter names whose value will be excluded from inspection during preconfigured WAF evaluation. Note that the parameter can be in the query string or in the POST body.
+              {
+                "op": "A String", # The match operator for the field.
+                "val": "A String", # The value of the field.
+              },
+            ],
+            "requestUrisToExclude": [ # A list of request URIs from the request line to be excluded from inspection during preconfigured WAF evaluation. When specifying this field, the query or fragment part should be excluded.
+              {
+                "op": "A String", # The match operator for the field.
+                "val": "A String", # The value of the field.
+              },
+            ],
+            "targetRuleIds": [ # A list of target rule IDs under the WAF rule set to apply the preconfigured WAF exclusion. If omitted, it refers to all the rule IDs under the WAF rule set.
+              "A String",
+            ],
+            "targetRuleSet": "A String", # Target WAF rule set to apply the preconfigured WAF exclusion.
+          },
+        ],
+      },
+      "preview": True or False, # If set to true, the specified action is not enforced.
+      "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority.
+      "rateLimitOptions": { # Must be specified if the action is "rate_based_ban" or "throttle" or "fairshare". Cannot be specified for any other actions.
+        "banDurationSec": 42, # Can only be specified if the action for the rule is "rate_based_ban". If specified, determines the time (in seconds) the traffic will continue to be banned by the rate limit after the rate falls below the threshold.
+        "banThreshold": { # Can only be specified if the action for the rule is "rate_based_ban". If specified, the key will be banned for the configured 'ban_duration_sec' when the number of requests that exceed the 'rate_limit_threshold' also exceed this 'ban_threshold'.
+          "count": 42, # Number of HTTP(S) requests for calculating the threshold.
+          "intervalSec": 42, # Interval over which the threshold is computed.
+        },
+        "conformAction": "A String", # Action to take for requests that are under the configured rate limit threshold. Valid option is "allow" only.
+        "enforceOnKey": "A String", # Determines the key to enforce the rate_limit_threshold on. Possible values are: - ALL: A single rate limit threshold is applied to all the requests matching this rule. This is the default value if "enforceOnKey" is not configured. - IP: The source IP address of the request is the key. Each IP has this limit enforced separately. - HTTP_HEADER: The value of the HTTP header whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to ALL. - XFF_IP: The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type IP. - HTTP_COOKIE: The value of the HTTP cookie whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to ALL. - HTTP_PATH: The URL path of the HTTP request. The key value is truncated to the first 128 bytes. - SNI: Server name indication in the TLS session of the HTTPS request. The key value is truncated to the first 128 bytes. The key type defaults to ALL on a HTTP session. - REGION_CODE: The country/region from which the request originates. - TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL. - USER_IP: The IP address of the originating client, which is resolved based on "userIpRequestHeaders" configured with the security policy. If there is no "userIpRequestHeaders" configuration or an IP address cannot be resolved from it, the key type defaults to IP. - TLS_JA4_FINGERPRINT: JA4 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL. For "fairshare" action, this value is limited to ALL i.e. a single rate limit threshold is enforced for all the requests matching the rule.
+        "enforceOnKeyConfigs": [ # If specified, any combination of values of enforce_on_key_type/enforce_on_key_name is treated as the key on which ratelimit threshold/action is enforced. You can specify up to 3 enforce_on_key_configs. If enforce_on_key_configs is specified, enforce_on_key must not be specified.
+          {
+            "enforceOnKeyName": "A String", # Rate limit key name applicable only for the following key types: HTTP_HEADER -- Name of the HTTP header whose value is taken as the key value. HTTP_COOKIE -- Name of the HTTP cookie whose value is taken as the key value.
+            "enforceOnKeyType": "A String", # Determines the key to enforce the rate_limit_threshold on. Possible values are: - ALL: A single rate limit threshold is applied to all the requests matching this rule. This is the default value if "enforceOnKeyConfigs" is not configured. - IP: The source IP address of the request is the key. Each IP has this limit enforced separately. - HTTP_HEADER: The value of the HTTP header whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to ALL. - XFF_IP: The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type IP. - HTTP_COOKIE: The value of the HTTP cookie whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to ALL. - HTTP_PATH: The URL path of the HTTP request. The key value is truncated to the first 128 bytes. - SNI: Server name indication in the TLS session of the HTTPS request. The key value is truncated to the first 128 bytes. The key type defaults to ALL on a HTTP session. - REGION_CODE: The country/region from which the request originates. - TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL. - USER_IP: The IP address of the originating client, which is resolved based on "userIpRequestHeaders" configured with the security policy. If there is no "userIpRequestHeaders" configuration or an IP address cannot be resolved from it, the key type defaults to IP. - TLS_JA4_FINGERPRINT: JA4 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL.
+          },
+        ],
+        "enforceOnKeyName": "A String", # Rate limit key name applicable only for the following key types: HTTP_HEADER -- Name of the HTTP header whose value is taken as the key value. HTTP_COOKIE -- Name of the HTTP cookie whose value is taken as the key value.
+        "exceedAction": "A String", # Action to take for requests that are above the configured rate limit threshold, to either deny with a specified HTTP response code, or redirect to a different endpoint. Valid options are `deny(STATUS)`, where valid values for `STATUS` are 403, 404, 429, and 502, and `redirect`, where the redirect parameters come from `exceedRedirectOptions` below. The `redirect` action is only supported in Global Security Policies of type CLOUD_ARMOR.
+        "exceedRedirectOptions": { # Parameters defining the redirect action that is used as the exceed action. Cannot be specified if the exceed action is not redirect. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
+          "target": "A String", # Target for the redirect action. This is required if the type is EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA.
+          "type": "A String", # Type of the redirect action. Possible values are: - GOOGLE_RECAPTCHA: redirect to reCAPTCHA for manual challenge assessment. - EXTERNAL_302: redirect to a different URL via a 302 response.
+        },
+        "rateLimitThreshold": { # Threshold at which to begin ratelimiting.
+          "count": 42, # Number of HTTP(S) requests for calculating the threshold.
+          "intervalSec": 42, # Interval over which the threshold is computed.
+        },
+      },
+      "redirectOptions": { # Parameters defining the redirect action. Cannot be specified for any other actions. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
+        "target": "A String", # Target for the redirect action. This is required if the type is EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA.
+        "type": "A String", # Type of the redirect action. Possible values are: - GOOGLE_RECAPTCHA: redirect to reCAPTCHA for manual challenge assessment. - EXTERNAL_302: redirect to a different URL via a 302 response.
+      },
+    },
+  ],
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "shortName": "A String", # User-provided name of the organization security policy. The name should be unique in the organization in which the security policy is created. This should only be used when SecurityPolicyType is CLOUD_ARMOR. The name must be 1-63 characters long, and comply with https://www.ietf.org/rfc/rfc1035.txt. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+  "type": "A String", # The type indicates the intended use of the security policy. - CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers. - CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache. - CLOUD_ARMOR_INTERNAL_SERVICE (preview only): Cloud Armor internal service policies can be configured to filter HTTP requests targeting services managed by Traffic Director in a service mesh. They filter requests before the request is served from the application. - CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application. This field can be set only at resource creation time.
+  "userDefinedFields": [ # Definitions of user-defined fields for CLOUD_ARMOR_NETWORK policies. A user-defined field consists of up to 4 bytes extracted from a fixed offset in the packet, relative to the IPv4, IPv6, TCP, or UDP header, with an optional mask to select certain bits. Rules may then specify matching values for these fields. Example: userDefinedFields: - name: "ipv4_fragment_offset" base: IPV4 offset: 6 size: 2 mask: "0x1fff"
+    {
+      "base": "A String", # The base relative to which 'offset' is measured. Possible values are: - IPV4: Points to the beginning of the IPv4 header. - IPV6: Points to the beginning of the IPv6 header. - TCP: Points to the beginning of the TCP header, skipping over any IPv4 options or IPv6 extension headers. Not present for non-first fragments. - UDP: Points to the beginning of the UDP header, skipping over any IPv4 options or IPv6 extension headers. Not present for non-first fragments. required
+      "mask": "A String", # If specified, apply this mask (bitwise AND) to the field to ignore bits before matching. Encoded as a hexadecimal number (starting with "0x"). The last byte of the field (in network byte order) corresponds to the least significant byte of the mask.
+      "name": "A String", # The name of this field. Must be unique within the policy.
+      "offset": 42, # Offset of the first byte of the field (in network byte order) relative to 'base'.
+      "size": 42, # Size of the field in bytes. Valid values: 1-4.
+    },
+  ],
+}
+
+  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/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling 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 in RFC3339 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 in RFC3339 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 different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be 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 in RFC3339 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.
+}
+
+ +
+ patchRule(securityPolicy, body=None, priority=None, requestId=None, x__xgafv=None) + 
Patches a rule at the specified priority. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.patchRule instead.
+
+Args:
+  securityPolicy: string, Name of the security policy to update. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).
+  "action": "A String", # The Action to perform when the rule is matched. The following are the valid actions: - allow: allow access to target. - deny(STATUS): deny access to target, returns the HTTP response code specified. Valid values for `STATUS` are 403, 404, and 502. - rate_based_ban: limit client traffic to the configured threshold and ban the client if the traffic exceeds the threshold. Configure parameters for this action in RateLimitOptions. Requires rate_limit_options to be set. - redirect: redirect to a different target. This can either be an internal reCAPTCHA redirect, or an external URL-based redirect via a 302 response. Parameters for this action can be configured via redirectOptions. This action is only supported in Global Security Policies of type CLOUD_ARMOR. - throttle: limit client traffic to the configured threshold. Configure parameters for this action in rateLimitOptions. Requires rate_limit_options to be set for this. - fairshare (preview only): when traffic reaches the threshold limit, requests from the clients matching this rule begin to be rate-limited using the Fair Share algorithm. This action is only allowed in security policies of type `CLOUD_ARMOR_INTERNAL_SERVICE`.
+  "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+  "headerAction": { # Optional, additional actions that are performed on headers. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
+    "requestHeadersToAdds": [ # The list of request headers to add or overwrite if they're already present.
+      {
+        "headerName": "A String", # The name of the header to set.
+        "headerValue": "A String", # The value to set the named header to.
+      },
+    ],
+  },
+  "kind": "compute#securityPolicyRule", # [Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules
+  "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
+    "config": { # The configuration options available when specifying versioned_expr. This field must be specified if versioned_expr is specified and cannot be specified if versioned_expr is not specified.
+      "srcIpRanges": [ # CIDR IP address range. Maximum number of src_ip_ranges allowed is 10.
+        "A String",
+      ],
+    },
+    "expr": { # 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. # User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header. Expressions containing `evaluateThreatIntelligence` require a Cloud Armor Enterprise subscription and are not supported in Edge Policies nor in Regional Policies. Expressions containing `evaluatePreconfiguredExpr('sourceiplist-*')` require a Cloud Armor Enterprise subscription and are only supported in Global Security 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.
+    },
+    "exprOptions": { # The configuration options available when specifying a user defined CEVAL expression (i.e., 'expr').
+      "recaptchaOptions": { # reCAPTCHA configuration options to be applied for the rule. If the rule does not evaluate reCAPTCHA tokens, this field has no effect.
+        "actionTokenSiteKeys": [ # A list of site keys to be used during the validation of reCAPTCHA action-tokens. The provided site keys need to be created from reCAPTCHA API under the same project where the security policy is created.
+          "A String",
+        ],
+        "sessionTokenSiteKeys": [ # A list of site keys to be used during the validation of reCAPTCHA session-tokens. The provided site keys need to be created from reCAPTCHA API under the same project where the security policy is created.
+          "A String",
+        ],
+      },
+    },
+    "versionedExpr": "A String", # Preconfigured versioned expression. If this field is specified, config must also be specified. Available preconfigured expressions along with their requirements are: SRC_IPS_V1 - must specify the corresponding src_ip_range field in config.
+  },
+  "networkMatch": { # Represents a match condition that incoming network traffic is evaluated against. # A match condition that incoming packets are evaluated against for CLOUD_ARMOR_NETWORK security policies. If it matches, the corresponding 'action' is enforced. The match criteria for a rule consists of built-in match fields (like 'srcIpRanges') and potentially multiple user-defined match fields ('userDefinedFields'). Field values may be extracted directly from the packet or derived from it (e.g. 'srcRegionCodes'). Some fields may not be present in every packet (e.g. 'srcPorts'). A user-defined field is only present if the base header is found in the packet and the entire field is in bounds. Each match field may specify which values can match it, listing one or more ranges, prefixes, or exact values that are considered a match for the field. A field value must be present in order to match a specified match field. If no match values are specified for a match field, then any field value is considered to match it, and it's not required to be present. For strings specifying '*' is also equivalent to match all. For a packet to match a rule, all specified match fields must match the corresponding field values derived from the packet. Example: networkMatch: srcIpRanges: - "192.0.2.0/24" - "198.51.100.0/24" userDefinedFields: - name: "ipv4_fragment_offset" values: - "1-0x1fff" The above match condition matches packets with a source IP in 192.0.2.0/24 or 198.51.100.0/24 and a user-defined field named "ipv4_fragment_offset" with a value between 1 and 0x1fff inclusive.
+    "destIpRanges": [ # Destination IPv4/IPv6 addresses or CIDR prefixes, in standard text format.
+      "A String",
+    ],
+    "destPorts": [ # Destination port numbers for TCP/UDP/SCTP. Each element can be a 16-bit unsigned decimal number (e.g. "80") or range (e.g. "0-1023").
+      "A String",
+    ],
+    "ipProtocols": [ # IPv4 protocol / IPv6 next header (after extension headers). Each element can be an 8-bit unsigned decimal number (e.g. "6"), range (e.g. "253-254"), or one of the following protocol names: "tcp", "udp", "icmp", "esp", "ah", "ipip", or "sctp".
+      "A String",
+    ],
+    "srcAsns": [ # BGP Autonomous System Number associated with the source IP address.
+      42,
+    ],
+    "srcIpRanges": [ # Source IPv4/IPv6 addresses or CIDR prefixes, in standard text format.
+      "A String",
+    ],
+    "srcPorts": [ # Source port numbers for TCP/UDP/SCTP. Each element can be a 16-bit unsigned decimal number (e.g. "80") or range (e.g. "0-1023").
+      "A String",
+    ],
+    "srcRegionCodes": [ # Two-letter ISO 3166-1 alpha-2 country code associated with the source IP address.
+      "A String",
+    ],
+    "userDefinedFields": [ # User-defined fields. Each element names a defined field and lists the matching values for that field.
+      {
+        "name": "A String", # Name of the user-defined field, as given in the definition.
+        "values": [ # Matching values of the field. Each element can be a 32-bit unsigned decimal or hexadecimal (starting with "0x") number (e.g. "64") or range (e.g. "0x400-0x7ff").
+          "A String",
+        ],
+      },
+    ],
+  },
+  "preconfiguredWafConfig": { # Preconfigured WAF configuration to be applied for the rule. If the rule does not evaluate preconfigured WAF rules, i.e., if evaluatePreconfiguredWaf() is not used, this field will have no effect.
+    "exclusions": [ # A list of exclusions to apply during preconfigured WAF evaluation.
+      {
+        "requestCookiesToExclude": [ # A list of request cookie names whose value will be excluded from inspection during preconfigured WAF evaluation.
+          {
+            "op": "A String", # The match operator for the field.
+            "val": "A String", # The value of the field.
+          },
+        ],
+        "requestHeadersToExclude": [ # A list of request header names whose value will be excluded from inspection during preconfigured WAF evaluation.
+          {
+            "op": "A String", # The match operator for the field.
+            "val": "A String", # The value of the field.
+          },
+        ],
+        "requestQueryParamsToExclude": [ # A list of request query parameter names whose value will be excluded from inspection during preconfigured WAF evaluation. Note that the parameter can be in the query string or in the POST body.
+          {
+            "op": "A String", # The match operator for the field.
+            "val": "A String", # The value of the field.
+          },
+        ],
+        "requestUrisToExclude": [ # A list of request URIs from the request line to be excluded from inspection during preconfigured WAF evaluation. When specifying this field, the query or fragment part should be excluded.
+          {
+            "op": "A String", # The match operator for the field.
+            "val": "A String", # The value of the field.
+          },
+        ],
+        "targetRuleIds": [ # A list of target rule IDs under the WAF rule set to apply the preconfigured WAF exclusion. If omitted, it refers to all the rule IDs under the WAF rule set.
+          "A String",
+        ],
+        "targetRuleSet": "A String", # Target WAF rule set to apply the preconfigured WAF exclusion.
+      },
+    ],
+  },
+  "preview": True or False, # If set to true, the specified action is not enforced.
+  "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority.
+  "rateLimitOptions": { # Must be specified if the action is "rate_based_ban" or "throttle" or "fairshare". Cannot be specified for any other actions.
+    "banDurationSec": 42, # Can only be specified if the action for the rule is "rate_based_ban". If specified, determines the time (in seconds) the traffic will continue to be banned by the rate limit after the rate falls below the threshold.
+    "banThreshold": { # Can only be specified if the action for the rule is "rate_based_ban". If specified, the key will be banned for the configured 'ban_duration_sec' when the number of requests that exceed the 'rate_limit_threshold' also exceed this 'ban_threshold'.
+      "count": 42, # Number of HTTP(S) requests for calculating the threshold.
+      "intervalSec": 42, # Interval over which the threshold is computed.
+    },
+    "conformAction": "A String", # Action to take for requests that are under the configured rate limit threshold. Valid option is "allow" only.
+    "enforceOnKey": "A String", # Determines the key to enforce the rate_limit_threshold on. Possible values are: - ALL: A single rate limit threshold is applied to all the requests matching this rule. This is the default value if "enforceOnKey" is not configured. - IP: The source IP address of the request is the key. Each IP has this limit enforced separately. - HTTP_HEADER: The value of the HTTP header whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to ALL. - XFF_IP: The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type IP. - HTTP_COOKIE: The value of the HTTP cookie whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to ALL. - HTTP_PATH: The URL path of the HTTP request. The key value is truncated to the first 128 bytes. - SNI: Server name indication in the TLS session of the HTTPS request. The key value is truncated to the first 128 bytes. The key type defaults to ALL on a HTTP session. - REGION_CODE: The country/region from which the request originates. - TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL. - USER_IP: The IP address of the originating client, which is resolved based on "userIpRequestHeaders" configured with the security policy. If there is no "userIpRequestHeaders" configuration or an IP address cannot be resolved from it, the key type defaults to IP. - TLS_JA4_FINGERPRINT: JA4 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL. For "fairshare" action, this value is limited to ALL i.e. a single rate limit threshold is enforced for all the requests matching the rule.
+    "enforceOnKeyConfigs": [ # If specified, any combination of values of enforce_on_key_type/enforce_on_key_name is treated as the key on which ratelimit threshold/action is enforced. You can specify up to 3 enforce_on_key_configs. If enforce_on_key_configs is specified, enforce_on_key must not be specified.
+      {
+        "enforceOnKeyName": "A String", # Rate limit key name applicable only for the following key types: HTTP_HEADER -- Name of the HTTP header whose value is taken as the key value. HTTP_COOKIE -- Name of the HTTP cookie whose value is taken as the key value.
+        "enforceOnKeyType": "A String", # Determines the key to enforce the rate_limit_threshold on. Possible values are: - ALL: A single rate limit threshold is applied to all the requests matching this rule. This is the default value if "enforceOnKeyConfigs" is not configured. - IP: The source IP address of the request is the key. Each IP has this limit enforced separately. - HTTP_HEADER: The value of the HTTP header whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to ALL. - XFF_IP: The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type IP. - HTTP_COOKIE: The value of the HTTP cookie whose name is configured under "enforceOnKeyName". The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to ALL. - HTTP_PATH: The URL path of the HTTP request. The key value is truncated to the first 128 bytes. - SNI: Server name indication in the TLS session of the HTTPS request. The key value is truncated to the first 128 bytes. The key type defaults to ALL on a HTTP session. - REGION_CODE: The country/region from which the request originates. - TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL. - USER_IP: The IP address of the originating client, which is resolved based on "userIpRequestHeaders" configured with the security policy. If there is no "userIpRequestHeaders" configuration or an IP address cannot be resolved from it, the key type defaults to IP. - TLS_JA4_FINGERPRINT: JA4 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL.
+      },
+    ],
+    "enforceOnKeyName": "A String", # Rate limit key name applicable only for the following key types: HTTP_HEADER -- Name of the HTTP header whose value is taken as the key value. HTTP_COOKIE -- Name of the HTTP cookie whose value is taken as the key value.
+    "exceedAction": "A String", # Action to take for requests that are above the configured rate limit threshold, to either deny with a specified HTTP response code, or redirect to a different endpoint. Valid options are `deny(STATUS)`, where valid values for `STATUS` are 403, 404, 429, and 502, and `redirect`, where the redirect parameters come from `exceedRedirectOptions` below. The `redirect` action is only supported in Global Security Policies of type CLOUD_ARMOR.
+    "exceedRedirectOptions": { # Parameters defining the redirect action that is used as the exceed action. Cannot be specified if the exceed action is not redirect. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
+      "target": "A String", # Target for the redirect action. This is required if the type is EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA.
+      "type": "A String", # Type of the redirect action. Possible values are: - GOOGLE_RECAPTCHA: redirect to reCAPTCHA for manual challenge assessment. - EXTERNAL_302: redirect to a different URL via a 302 response.
+    },
+    "rateLimitThreshold": { # Threshold at which to begin ratelimiting.
+      "count": 42, # Number of HTTP(S) requests for calculating the threshold.
+      "intervalSec": 42, # Interval over which the threshold is computed.
+    },
+  },
+  "redirectOptions": { # Parameters defining the redirect action. Cannot be specified for any other actions. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
+    "target": "A String", # Target for the redirect action. This is required if the type is EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA.
+    "type": "A String", # Type of the redirect action. Possible values are: - GOOGLE_RECAPTCHA: redirect to reCAPTCHA for manual challenge assessment. - EXTERNAL_302: redirect to a different URL via a 302 response.
+  },
+}
+
+  priority: integer, The priority of the rule to patch.
+  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/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling 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 in RFC3339 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 in RFC3339 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 different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be 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 in RFC3339 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.
+}
+
+ +
+ removeAssociation(securityPolicy, name=None, requestId=None, x__xgafv=None) + 
Removes an association for the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.removeAssociation instead if possible.
+
+Args:
+  securityPolicy: string, Name of the security policy to update. (required)
+  name: string, Name for the attachment that will be removed.
+  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/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling 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 in RFC3339 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 in RFC3339 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 different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be 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 in RFC3339 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.
+}
+
+ +
+ removeRule(securityPolicy, priority=None, requestId=None, x__xgafv=None) + 
Deletes a rule at the specified priority.
+
+Args:
+  securityPolicy: string, Name of the security policy to update. (required)
+  priority: integer, The priority of the rule to remove from the security policy.
+  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/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling 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 in RFC3339 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 in RFC3339 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 different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be 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 in RFC3339 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.previewFeatures.html b/docs/dyn/compute_v1.previewFeatures.html new file mode 100644 index 00000000000..8c8543e4960 --- /dev/null +++ b/docs/dyn/compute_v1.previewFeatures.html @@ -0,0 +1,380 @@ + + + +

Compute Engine API . previewFeatures

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(project, previewFeature, x__xgafv=None)

+

Returns the details of the given PreviewFeature.

+

+ list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Returns the details of the given PreviewFeature.

+

+ list_next()

+

Retrieves the next page of results.

+

+ update(project, previewFeature, body=None, requestId=None, x__xgafv=None)

+

Patches the given PreviewFeature. This method is used to enable or disable a PreviewFeature.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ get(project, previewFeature, x__xgafv=None) + 
Returns the details of the given PreviewFeature.
+
+Args:
+  project: string, Project ID for this request. (required)
+  previewFeature: string, Name of the PreviewFeature for this request. (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 single Google Compute Engine preview feature.
+  "activationStatus": "A String", # Specifies whether the feature is enabled or disabled.
+  "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+  "description": "A String", # [Output Only] Description of the feature.
+  "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+  "kind": "compute#previewFeature", # [Output only] The type of the feature. Always "compute#previewFeature" for preview features.
+  "name": "A String", # Name of the feature.
+  "rolloutOperation": { # Represents the rollout operation # Rollout operation of the feature.
+    "rolloutInput": { # Represents the input for the rollout operation. # Input only. The input for the rollout operation.
+      "name": "A String", # The name of the rollout plan Ex. organizations//locations/global/rolloutPlans/ Ex. folders//locations/global/rolloutPlans/ Ex. projects//locations/global/rolloutPlans/.
+      "predefinedRolloutPlan": "A String", # Predefined rollout plan.
+    },
+  },
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "status": { # [Output Only] The status of the feature. # [Output only] Status of the feature.
+    "description": "A String", # [Output Only] The description of the feature.
+    "helpLink": "A String", # [Output Only] Link to the public documentation for the feature.
+    "releaseStatus": { # [Output Only] The release status of the feature.
+      "stage": "A String", # [Output Only] The stage of the feature.
+      "updateDate": { # 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 last date when a feature transitioned between ReleaseStatuses.
+        "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.
+      },
+    },
+  },
+}
+
+ +
+ list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Returns the details of the given PreviewFeature.
+
+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 on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
+  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 PreviewFeature resources.
+    { # Represents a single Google Compute Engine preview feature.
+      "activationStatus": "A String", # Specifies whether the feature is enabled or disabled.
+      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+      "description": "A String", # [Output Only] Description of the feature.
+      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+      "kind": "compute#previewFeature", # [Output only] The type of the feature. Always "compute#previewFeature" for preview features.
+      "name": "A String", # Name of the feature.
+      "rolloutOperation": { # Represents the rollout operation # Rollout operation of the feature.
+        "rolloutInput": { # Represents the input for the rollout operation. # Input only. The input for the rollout operation.
+          "name": "A String", # The name of the rollout plan Ex. organizations//locations/global/rolloutPlans/ Ex. folders//locations/global/rolloutPlans/ Ex. projects//locations/global/rolloutPlans/.
+          "predefinedRolloutPlan": "A String", # Predefined rollout plan.
+        },
+      },
+      "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+      "status": { # [Output Only] The status of the feature. # [Output only] Status of the feature.
+        "description": "A String", # [Output Only] The description of the feature.
+        "helpLink": "A String", # [Output Only] Link to the public documentation for the feature.
+        "releaseStatus": { # [Output Only] The release status of the feature.
+          "stage": "A String", # [Output Only] The stage of the feature.
+          "updateDate": { # 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 last date when a feature transitioned between ReleaseStatuses.
+            "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.
+          },
+        },
+      },
+    },
+  ],
+  "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 than maxResults, use the nextPageToken as a value 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.
+
+
+ +
+ update(project, previewFeature, body=None, requestId=None, x__xgafv=None) + 
Patches the given PreviewFeature. This method is used to enable or disable a PreviewFeature.
+
+Args:
+  project: string, Project ID for this request. (required)
+  previewFeature: string, Name of the PreviewFeature for this request. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a single Google Compute Engine preview feature.
+  "activationStatus": "A String", # Specifies whether the feature is enabled or disabled.
+  "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+  "description": "A String", # [Output Only] Description of the feature.
+  "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+  "kind": "compute#previewFeature", # [Output only] The type of the feature. Always "compute#previewFeature" for preview features.
+  "name": "A String", # Name of the feature.
+  "rolloutOperation": { # Represents the rollout operation # Rollout operation of the feature.
+    "rolloutInput": { # Represents the input for the rollout operation. # Input only. The input for the rollout operation.
+      "name": "A String", # The name of the rollout plan Ex. organizations//locations/global/rolloutPlans/ Ex. folders//locations/global/rolloutPlans/ Ex. projects//locations/global/rolloutPlans/.
+      "predefinedRolloutPlan": "A String", # Predefined rollout plan.
+    },
+  },
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "status": { # [Output Only] The status of the feature. # [Output only] Status of the feature.
+    "description": "A String", # [Output Only] The description of the feature.
+    "helpLink": "A String", # [Output Only] Link to the public documentation for the feature.
+    "releaseStatus": { # [Output Only] The release status of the feature.
+      "stage": "A String", # [Output Only] The stage of the feature.
+      "updateDate": { # 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 last date when a feature transitioned between ReleaseStatuses.
+        "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.
+      },
+    },
+  },
+}
+
+  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/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling 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 in RFC3339 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 in RFC3339 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 different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be 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 in RFC3339 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.regionDisks.html b/docs/dyn/compute_v1.regionDisks.html index 1cf53f0af50..c9817ef0ade 100644 --- a/docs/dyn/compute_v1.regionDisks.html +++ b/docs/dyn/compute_v1.regionDisks.html @@ -413,7 +413,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. LINT.IfChange +{ # Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. "architecture": "A String", # [Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64. "autoCreated": True or False, # [Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk. "chainName": "A String", # Creates the new snapshot in the snapshot chain labeled with the specified name. The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value. @@ -443,6 +443,11 @@

Method Details

], "locationHint": "A String", # An opaque location hint used to place the snapshot close to other resources. This field is for use by internal tools that use the public API. "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 with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + "params": { # Additional snapshot params. # Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. + "resourceManagerTags": { # Resource manager tags to be bound to the snapshot. 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", + }, + }, "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. diff --git a/docs/dyn/compute_v1.regionSecurityPolicies.html b/docs/dyn/compute_v1.regionSecurityPolicies.html index c9dece9af92..59aa69baccc 100644 --- a/docs/dyn/compute_v1.regionSecurityPolicies.html +++ b/docs/dyn/compute_v1.regionSecurityPolicies.html @@ -557,6 +557,21 @@

Method Details

"A String", ], }, + "associations": [ # A list of associations that belong to this policy. + { + "attachmentId": "A String", # The resource that the security policy is attached to. + "displayName": "A String", # [Output Only] The display name of the security policy of the association. + "excludedFolders": [ # A list of folders to exclude from the security policy. + "A String", + ], + "excludedProjects": [ # A list of projects to exclude from the security policy. + "A String", + ], + "name": "A String", # The name for an association. + "securityPolicyId": "A String", # [Output Only] The security policy ID of the association. + "shortName": "A String", # [Output Only] The short name of the security policy of the association. + }, + ], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "ddosProtectionConfig": { "ddosProtection": "A String", @@ -710,6 +725,7 @@

Method Details

}, ], "selfLink": "A String", # [Output Only] Server-defined URL for the resource. + "shortName": "A String", # User-provided name of the organization security policy. The name should be unique in the organization in which the security policy is created. This should only be used when SecurityPolicyType is CLOUD_ARMOR. The name must be 1-63 characters long, and comply with https://www.ietf.org/rfc/rfc1035.txt. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "type": "A String", # The type indicates the intended use of the security policy. - CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers. - CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache. - CLOUD_ARMOR_INTERNAL_SERVICE (preview only): Cloud Armor internal service policies can be configured to filter HTTP requests targeting services managed by Traffic Director in a service mesh. They filter requests before the request is served from the application. - CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application. This field can be set only at resource creation time. "userDefinedFields": [ # Definitions of user-defined fields for CLOUD_ARMOR_NETWORK policies. A user-defined field consists of up to 4 bytes extracted from a fixed offset in the packet, relative to the IPv4, IPv6, TCP, or UDP header, with an optional mask to select certain bits. Rules may then specify matching values for these fields. Example: userDefinedFields: - name: "ipv4_fragment_offset" base: IPV4 offset: 6 size: 2 mask: "0x1fff" { @@ -923,6 +939,21 @@

Method Details

"A String", ], }, + "associations": [ # A list of associations that belong to this policy. + { + "attachmentId": "A String", # The resource that the security policy is attached to. + "displayName": "A String", # [Output Only] The display name of the security policy of the association. + "excludedFolders": [ # A list of folders to exclude from the security policy. + "A String", + ], + "excludedProjects": [ # A list of projects to exclude from the security policy. + "A String", + ], + "name": "A String", # The name for an association. + "securityPolicyId": "A String", # [Output Only] The security policy ID of the association. + "shortName": "A String", # [Output Only] The short name of the security policy of the association. + }, + ], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "ddosProtectionConfig": { "ddosProtection": "A String", @@ -1076,6 +1107,7 @@

Method Details

}, ], "selfLink": "A String", # [Output Only] Server-defined URL for the resource. + "shortName": "A String", # User-provided name of the organization security policy. The name should be unique in the organization in which the security policy is created. This should only be used when SecurityPolicyType is CLOUD_ARMOR. The name must be 1-63 characters long, and comply with https://www.ietf.org/rfc/rfc1035.txt. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "type": "A String", # The type indicates the intended use of the security policy. - CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers. - CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache. - CLOUD_ARMOR_INTERNAL_SERVICE (preview only): Cloud Armor internal service policies can be configured to filter HTTP requests targeting services managed by Traffic Director in a service mesh. They filter requests before the request is served from the application. - CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application. This field can be set only at resource creation time. "userDefinedFields": [ # Definitions of user-defined fields for CLOUD_ARMOR_NETWORK policies. A user-defined field consists of up to 4 bytes extracted from a fixed offset in the packet, relative to the IPv4, IPv6, TCP, or UDP header, with an optional mask to select certain bits. Rules may then specify matching values for these fields. Example: userDefinedFields: - name: "ipv4_fragment_offset" base: IPV4 offset: 6 size: 2 mask: "0x1fff" { @@ -1267,6 +1299,21 @@

Method Details

"A String", ], }, + "associations": [ # A list of associations that belong to this policy. + { + "attachmentId": "A String", # The resource that the security policy is attached to. + "displayName": "A String", # [Output Only] The display name of the security policy of the association. + "excludedFolders": [ # A list of folders to exclude from the security policy. + "A String", + ], + "excludedProjects": [ # A list of projects to exclude from the security policy. + "A String", + ], + "name": "A String", # The name for an association. + "securityPolicyId": "A String", # [Output Only] The security policy ID of the association. + "shortName": "A String", # [Output Only] The short name of the security policy of the association. + }, + ], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "ddosProtectionConfig": { "ddosProtection": "A String", @@ -1420,6 +1467,7 @@

Method Details

}, ], "selfLink": "A String", # [Output Only] Server-defined URL for the resource. + "shortName": "A String", # User-provided name of the organization security policy. The name should be unique in the organization in which the security policy is created. This should only be used when SecurityPolicyType is CLOUD_ARMOR. The name must be 1-63 characters long, and comply with https://www.ietf.org/rfc/rfc1035.txt. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "type": "A String", # The type indicates the intended use of the security policy. - CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers. - CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache. - CLOUD_ARMOR_INTERNAL_SERVICE (preview only): Cloud Armor internal service policies can be configured to filter HTTP requests targeting services managed by Traffic Director in a service mesh. They filter requests before the request is served from the application. - CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application. This field can be set only at resource creation time. "userDefinedFields": [ # Definitions of user-defined fields for CLOUD_ARMOR_NETWORK policies. A user-defined field consists of up to 4 bytes extracted from a fixed offset in the packet, relative to the IPv4, IPv6, TCP, or UDP header, with an optional mask to select certain bits. Rules may then specify matching values for these fields. Example: userDefinedFields: - name: "ipv4_fragment_offset" base: IPV4 offset: 6 size: 2 mask: "0x1fff" { @@ -1510,6 +1558,21 @@

Method Details

"A String", ], }, + "associations": [ # A list of associations that belong to this policy. + { + "attachmentId": "A String", # The resource that the security policy is attached to. + "displayName": "A String", # [Output Only] The display name of the security policy of the association. + "excludedFolders": [ # A list of folders to exclude from the security policy. + "A String", + ], + "excludedProjects": [ # A list of projects to exclude from the security policy. + "A String", + ], + "name": "A String", # The name for an association. + "securityPolicyId": "A String", # [Output Only] The security policy ID of the association. + "shortName": "A String", # [Output Only] The short name of the security policy of the association. + }, + ], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "ddosProtectionConfig": { "ddosProtection": "A String", @@ -1663,6 +1726,7 @@

Method Details

}, ], "selfLink": "A String", # [Output Only] Server-defined URL for the resource. + "shortName": "A String", # User-provided name of the organization security policy. The name should be unique in the organization in which the security policy is created. This should only be used when SecurityPolicyType is CLOUD_ARMOR. The name must be 1-63 characters long, and comply with https://www.ietf.org/rfc/rfc1035.txt. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "type": "A String", # The type indicates the intended use of the security policy. - CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers. - CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache. - CLOUD_ARMOR_INTERNAL_SERVICE (preview only): Cloud Armor internal service policies can be configured to filter HTTP requests targeting services managed by Traffic Director in a service mesh. They filter requests before the request is served from the application. - CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application. This field can be set only at resource creation time. "userDefinedFields": [ # Definitions of user-defined fields for CLOUD_ARMOR_NETWORK policies. A user-defined field consists of up to 4 bytes extracted from a fixed offset in the packet, relative to the IPv4, IPv6, TCP, or UDP header, with an optional mask to select certain bits. Rules may then specify matching values for these fields. Example: userDefinedFields: - name: "ipv4_fragment_offset" base: IPV4 offset: 6 size: 2 mask: "0x1fff" { diff --git a/docs/dyn/compute_v1.reservationSubBlocks.html b/docs/dyn/compute_v1.reservationSubBlocks.html index 4112efc9e43..cec7320cefb 100644 --- a/docs/dyn/compute_v1.reservationSubBlocks.html +++ b/docs/dyn/compute_v1.reservationSubBlocks.html @@ -89,6 +89,9 @@

Instance Methods

performMaintenance(project, zone, parentName, reservationSubBlock, requestId=None, x__xgafv=None)

Allows customers to perform maintenance on a reservation subBlock

+

+ reportFaulty(project, zone, parentName, reservationSubBlock, body=None, requestId=None, x__xgafv=None)

+

Allows customers to report a faulty subBlock.

Method Details

close() @@ -387,4 +390,144 @@

Method Details

}
+
+ reportFaulty(project, zone, parentName, reservationSubBlock, body=None, requestId=None, x__xgafv=None) + 
Allows customers to report a faulty subBlock.
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, Name of the zone for this request. Zone name should conform to RFC1035. (required)
+  parentName: string, The name of the parent reservation and parent block. In the format of 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)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "disruptionSchedule": "A String", # The disruption schedule for the subBlock.
+  "failureComponent": "A String", # The component that experienced the fault.
+  "faultReasons": [ # The reasons for the fault experienced with the subBlock.
+    { # The reason for the fault experienced with the subBlock.
+      "behavior": "A String", # The behavior of the fault experienced with the subBlock.
+      "description": "A String", # The description of the fault experienced with the subBlock.
+    },
+  ],
+}
+
+  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/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling 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 in RFC3339 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 in RFC3339 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 different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be 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 in RFC3339 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.securityPolicies.html b/docs/dyn/compute_v1.securityPolicies.html index 7524876e524..905c6907a3e 100644 --- a/docs/dyn/compute_v1.securityPolicies.html +++ b/docs/dyn/compute_v1.securityPolicies.html @@ -446,6 +446,21 @@

Method Details

"A String", ], }, + "associations": [ # A list of associations that belong to this policy. + { + "attachmentId": "A String", # The resource that the security policy is attached to. + "displayName": "A String", # [Output Only] The display name of the security policy of the association. + "excludedFolders": [ # A list of folders to exclude from the security policy. + "A String", + ], + "excludedProjects": [ # A list of projects to exclude from the security policy. + "A String", + ], + "name": "A String", # The name for an association. + "securityPolicyId": "A String", # [Output Only] The security policy ID of the association. + "shortName": "A String", # [Output Only] The short name of the security policy of the association. + }, + ], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "ddosProtectionConfig": { "ddosProtection": "A String", @@ -599,6 +614,7 @@

Method Details

}, ], "selfLink": "A String", # [Output Only] Server-defined URL for the resource. + "shortName": "A String", # User-provided name of the organization security policy. The name should be unique in the organization in which the security policy is created. This should only be used when SecurityPolicyType is CLOUD_ARMOR. The name must be 1-63 characters long, and comply with https://www.ietf.org/rfc/rfc1035.txt. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "type": "A String", # The type indicates the intended use of the security policy. - CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers. - CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache. - CLOUD_ARMOR_INTERNAL_SERVICE (preview only): Cloud Armor internal service policies can be configured to filter HTTP requests targeting services managed by Traffic Director in a service mesh. They filter requests before the request is served from the application. - CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application. This field can be set only at resource creation time. "userDefinedFields": [ # Definitions of user-defined fields for CLOUD_ARMOR_NETWORK policies. A user-defined field consists of up to 4 bytes extracted from a fixed offset in the packet, relative to the IPv4, IPv6, TCP, or UDP header, with an optional mask to select certain bits. Rules may then specify matching values for these fields. Example: userDefinedFields: - name: "ipv4_fragment_offset" base: IPV4 offset: 6 size: 2 mask: "0x1fff" { @@ -838,6 +854,21 @@

Method Details

"A String", ], }, + "associations": [ # A list of associations that belong to this policy. + { + "attachmentId": "A String", # The resource that the security policy is attached to. + "displayName": "A String", # [Output Only] The display name of the security policy of the association. + "excludedFolders": [ # A list of folders to exclude from the security policy. + "A String", + ], + "excludedProjects": [ # A list of projects to exclude from the security policy. + "A String", + ], + "name": "A String", # The name for an association. + "securityPolicyId": "A String", # [Output Only] The security policy ID of the association. + "shortName": "A String", # [Output Only] The short name of the security policy of the association. + }, + ], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "ddosProtectionConfig": { "ddosProtection": "A String", @@ -991,6 +1022,7 @@

Method Details

}, ], "selfLink": "A String", # [Output Only] Server-defined URL for the resource. + "shortName": "A String", # User-provided name of the organization security policy. The name should be unique in the organization in which the security policy is created. This should only be used when SecurityPolicyType is CLOUD_ARMOR. The name must be 1-63 characters long, and comply with https://www.ietf.org/rfc/rfc1035.txt. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "type": "A String", # The type indicates the intended use of the security policy. - CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers. - CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache. - CLOUD_ARMOR_INTERNAL_SERVICE (preview only): Cloud Armor internal service policies can be configured to filter HTTP requests targeting services managed by Traffic Director in a service mesh. They filter requests before the request is served from the application. - CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application. This field can be set only at resource creation time. "userDefinedFields": [ # Definitions of user-defined fields for CLOUD_ARMOR_NETWORK policies. A user-defined field consists of up to 4 bytes extracted from a fixed offset in the packet, relative to the IPv4, IPv6, TCP, or UDP header, with an optional mask to select certain bits. Rules may then specify matching values for these fields. Example: userDefinedFields: - name: "ipv4_fragment_offset" base: IPV4 offset: 6 size: 2 mask: "0x1fff" { @@ -1202,6 +1234,21 @@

Method Details

"A String", ], }, + "associations": [ # A list of associations that belong to this policy. + { + "attachmentId": "A String", # The resource that the security policy is attached to. + "displayName": "A String", # [Output Only] The display name of the security policy of the association. + "excludedFolders": [ # A list of folders to exclude from the security policy. + "A String", + ], + "excludedProjects": [ # A list of projects to exclude from the security policy. + "A String", + ], + "name": "A String", # The name for an association. + "securityPolicyId": "A String", # [Output Only] The security policy ID of the association. + "shortName": "A String", # [Output Only] The short name of the security policy of the association. + }, + ], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "ddosProtectionConfig": { "ddosProtection": "A String", @@ -1355,6 +1402,7 @@

Method Details

}, ], "selfLink": "A String", # [Output Only] Server-defined URL for the resource. + "shortName": "A String", # User-provided name of the organization security policy. The name should be unique in the organization in which the security policy is created. This should only be used when SecurityPolicyType is CLOUD_ARMOR. The name must be 1-63 characters long, and comply with https://www.ietf.org/rfc/rfc1035.txt. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "type": "A String", # The type indicates the intended use of the security policy. - CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers. - CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache. - CLOUD_ARMOR_INTERNAL_SERVICE (preview only): Cloud Armor internal service policies can be configured to filter HTTP requests targeting services managed by Traffic Director in a service mesh. They filter requests before the request is served from the application. - CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application. This field can be set only at resource creation time. "userDefinedFields": [ # Definitions of user-defined fields for CLOUD_ARMOR_NETWORK policies. A user-defined field consists of up to 4 bytes extracted from a fixed offset in the packet, relative to the IPv4, IPv6, TCP, or UDP header, with an optional mask to select certain bits. Rules may then specify matching values for these fields. Example: userDefinedFields: - name: "ipv4_fragment_offset" base: IPV4 offset: 6 size: 2 mask: "0x1fff" { @@ -1545,6 +1593,21 @@

Method Details

"A String", ], }, + "associations": [ # A list of associations that belong to this policy. + { + "attachmentId": "A String", # The resource that the security policy is attached to. + "displayName": "A String", # [Output Only] The display name of the security policy of the association. + "excludedFolders": [ # A list of folders to exclude from the security policy. + "A String", + ], + "excludedProjects": [ # A list of projects to exclude from the security policy. + "A String", + ], + "name": "A String", # The name for an association. + "securityPolicyId": "A String", # [Output Only] The security policy ID of the association. + "shortName": "A String", # [Output Only] The short name of the security policy of the association. + }, + ], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "ddosProtectionConfig": { "ddosProtection": "A String", @@ -1698,6 +1761,7 @@

Method Details

}, ], "selfLink": "A String", # [Output Only] Server-defined URL for the resource. + "shortName": "A String", # User-provided name of the organization security policy. The name should be unique in the organization in which the security policy is created. This should only be used when SecurityPolicyType is CLOUD_ARMOR. The name must be 1-63 characters long, and comply with https://www.ietf.org/rfc/rfc1035.txt. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "type": "A String", # The type indicates the intended use of the security policy. - CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers. - CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache. - CLOUD_ARMOR_INTERNAL_SERVICE (preview only): Cloud Armor internal service policies can be configured to filter HTTP requests targeting services managed by Traffic Director in a service mesh. They filter requests before the request is served from the application. - CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application. This field can be set only at resource creation time. "userDefinedFields": [ # Definitions of user-defined fields for CLOUD_ARMOR_NETWORK policies. A user-defined field consists of up to 4 bytes extracted from a fixed offset in the packet, relative to the IPv4, IPv6, TCP, or UDP header, with an optional mask to select certain bits. Rules may then specify matching values for these fields. Example: userDefinedFields: - name: "ipv4_fragment_offset" base: IPV4 offset: 6 size: 2 mask: "0x1fff" { @@ -1828,6 +1892,21 @@

Method Details

"A String", ], }, + "associations": [ # A list of associations that belong to this policy. + { + "attachmentId": "A String", # The resource that the security policy is attached to. + "displayName": "A String", # [Output Only] The display name of the security policy of the association. + "excludedFolders": [ # A list of folders to exclude from the security policy. + "A String", + ], + "excludedProjects": [ # A list of projects to exclude from the security policy. + "A String", + ], + "name": "A String", # The name for an association. + "securityPolicyId": "A String", # [Output Only] The security policy ID of the association. + "shortName": "A String", # [Output Only] The short name of the security policy of the association. + }, + ], "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "ddosProtectionConfig": { "ddosProtection": "A String", @@ -1981,6 +2060,7 @@

Method Details

}, ], "selfLink": "A String", # [Output Only] Server-defined URL for the resource. + "shortName": "A String", # User-provided name of the organization security policy. The name should be unique in the organization in which the security policy is created. This should only be used when SecurityPolicyType is CLOUD_ARMOR. The name must be 1-63 characters long, and comply with https://www.ietf.org/rfc/rfc1035.txt. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "type": "A String", # The type indicates the intended use of the security policy. - CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers. - CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache. - CLOUD_ARMOR_INTERNAL_SERVICE (preview only): Cloud Armor internal service policies can be configured to filter HTTP requests targeting services managed by Traffic Director in a service mesh. They filter requests before the request is served from the application. - CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application. This field can be set only at resource creation time. "userDefinedFields": [ # Definitions of user-defined fields for CLOUD_ARMOR_NETWORK policies. A user-defined field consists of up to 4 bytes extracted from a fixed offset in the packet, relative to the IPv4, IPv6, TCP, or UDP header, with an optional mask to select certain bits. Rules may then specify matching values for these fields. Example: userDefinedFields: - name: "ipv4_fragment_offset" base: IPV4 offset: 6 size: 2 mask: "0x1fff" { diff --git a/docs/dyn/compute_v1.snapshots.html b/docs/dyn/compute_v1.snapshots.html index 43183e9c263..06b6ec0dfff 100644 --- a/docs/dyn/compute_v1.snapshots.html +++ b/docs/dyn/compute_v1.snapshots.html @@ -249,7 +249,7 @@

Method Details

Returns: An object of the form: - { # Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. LINT.IfChange + { # Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. "architecture": "A String", # [Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64. "autoCreated": True or False, # [Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk. "chainName": "A String", # Creates the new snapshot in the snapshot chain labeled with the specified name. The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value. @@ -279,6 +279,11 @@

Method Details

], "locationHint": "A String", # An opaque location hint used to place the snapshot close to other resources. This field is for use by internal tools that use the public API. "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 with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + "params": { # Additional snapshot params. # Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. + "resourceManagerTags": { # Resource manager tags to be bound to the snapshot. 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", + }, + }, "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. @@ -378,7 +383,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. LINT.IfChange +{ # Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. "architecture": "A String", # [Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64. "autoCreated": True or False, # [Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk. "chainName": "A String", # Creates the new snapshot in the snapshot chain labeled with the specified name. The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value. @@ -408,6 +413,11 @@

Method Details

], "locationHint": "A String", # An opaque location hint used to place the snapshot close to other resources. This field is for use by internal tools that use the public API. "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 with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + "params": { # Additional snapshot params. # Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. + "resourceManagerTags": { # Resource manager tags to be bound to the snapshot. 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", + }, + }, "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. @@ -587,7 +597,7 @@

Method Details

{ # Contains a list of Snapshot resources. "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. "items": [ # A list of Snapshot resources. - { # Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. LINT.IfChange + { # Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. "architecture": "A String", # [Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64. "autoCreated": True or False, # [Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk. "chainName": "A String", # Creates the new snapshot in the snapshot chain labeled with the specified name. The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value. @@ -617,6 +627,11 @@

Method Details

], "locationHint": "A String", # An opaque location hint used to place the snapshot close to other resources. This field is for use by internal tools that use the public API. "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 with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + "params": { # Additional snapshot params. # Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. + "resourceManagerTags": { # Resource manager tags to be bound to the snapshot. 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", + }, + }, "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. diff --git a/googleapiclient/discovery_cache/documents/compute.alpha.json b/googleapiclient/discovery_cache/documents/compute.alpha.json index 0a8f60a7eb4..c1081a23a13 100644 --- a/googleapiclient/discovery_cache/documents/compute.alpha.json +++ b/googleapiclient/discovery_cache/documents/compute.alpha.json @@ -4029,11 +4029,11 @@ "https://www.googleapis.com/auth/compute" ] }, -"updateKmskey": { +"updateKmsKey": { "description": "Rotates the customer-managed encryption key to the latest version for the specified persistent disk.", "flatPath": "projects/{project}/zones/{zone}/disks/{disk}/updateKmsKey", "httpMethod": "POST", -"id": "compute.disks.updateKmskey", +"id": "compute.disks.updateKmsKey", "parameterOrder": [ "project", "zone", @@ -35831,7 +35831,7 @@ ] }, "aggregatedList": { -"description": "Retrieves an aggregated list of network policies. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", +"description": "Retrieves an aggregated list of network policies. To prevent failure, it's recommended that you set the `returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/networkPolicies", "httpMethod": "GET", "id": "compute.regionNetworkPolicies.aggregatedList", @@ -36257,7 +36257,7 @@ "type": "string" }, "priority": { -"description": "The priority of the rule to patch.", +"description": "The priority of the traffic classification rule to patch. Only rules with a priority value between 1 and 2147482647 (inclusive) can be patched.", "format": "int32", "location": "query", "type": "integer" @@ -52556,7 +52556,7 @@ } } }, -"revision": "20250909", +"revision": "20250916", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -53219,6 +53219,10 @@ false "format": "uint64", "type": "string" }, +"ipCollection": { +"description": "Reference to the source of external IPv4 addresses, like a PublicDelegatedPrefix (PDP) for BYOIP. The PDP must support enhanced IPv4 allocations. Use one of the following formats to specify a PDP when reserving an external IPv4 address using BYOIP. - Full resource URL, as in https://www.googleapis.com/compute/v1/projects/projectId/regions/region /publicDelegatedPrefixes/pdp-name - Partial URL, as in - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name - regions/region/publicDelegatedPrefixes/pdp-name ", +"type": "string" +}, "ipVersion": { "description": "The IP version that will be used by this address. Valid options are IPV4 or IPV6.", "enum": [ @@ -64445,10 +64449,6 @@ false "target": { "description": "The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. - For load balancers, see the \"Target\" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. The target is not mutable once set as a service attachment. ", "type": "string" -}, -"trafficDisabled": { -"description": "[PSC for VPC-hosted services only] Determines if clients are allowed to access the producer service via this PSC endpoint.", -"type": "boolean" } }, "type": "object" @@ -84403,6 +84403,10 @@ false "NamedSet": { "id": "NamedSet", "properties": { +"description": { +"description": "An optional description of named set.", +"type": "string" +}, "elements": { "description": "CEL expressions that are comparable to constructs of this set's type (see Policy Language).", "items": { @@ -86744,6 +86748,10 @@ false }, "type": "array" }, +"enableVpcScopedDns": { +"description": "Optional. If true, DNS resolution will be enabled over this interface. Only valid with network_attachment.", +"type": "boolean" +}, "fingerprint": { "description": "Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.", "format": "byte", @@ -87883,6 +87891,23 @@ false "NetworkPolicyTrafficClassificationRuleAction": { "id": "NetworkPolicyTrafficClassificationRuleAction", "properties": { +"dscpMode": { +"description": "The traffic class that should be applied to the matching packet.", +"enum": [ +"AUTO", +"CUSTOM" +], +"enumDescriptions": [ +"DSCP value will be automatically picked up based on configured traffic_class.", +"Allows to specify custom DSCP value from selected traffic_class range." +], +"type": "string" +}, +"dscpValue": { +"description": "Custom DSCP value from 0-63 range.", +"format": "int32", +"type": "integer" +}, "fieldType": { "description": "The field type could be one of: TRAFFIC_CLASS or DSCP.", "enum": [ @@ -87902,6 +87927,26 @@ false "format": "int32", "type": "integer" }, +"trafficClass": { +"description": "The traffic class that should be applied to the matching packet.", +"enum": [ +"TC1", +"TC2", +"TC3", +"TC4", +"TC5", +"TC6" +], +"enumDescriptions": [ +"Traffic Class 1, corresponding to DSCP ranges (0-7) 000xxx.", +"Traffic Class 2, corresponding to DSCP ranges (8-15) 001xxx.", +"Traffic Class 3, corresponding to DSCP ranges (16-23) 010xxx.", +"Traffic Class 4, corresponding to DSCP ranges (24-31) 011xxx.", +"Traffic Class 5, corresponding to DSCP ranges (32-47) 10xxxx.", +"Traffic Class 6, corresponding to DSCP ranges (48-63) 11xxxx." +], +"type": "string" +}, "type": { "description": "Always \"apply_traffic_classification\" for traffic classification rules.", "type": "string" @@ -94424,6 +94469,10 @@ false "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, +"enableEnhancedIpv4Allocation": { +"description": "[Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only.", +"type": "boolean" +}, "fingerprint": { "description": "Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix.", "format": "byte", @@ -94880,6 +94929,10 @@ false "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, +"enableEnhancedIpv4Allocation": { +"description": "[Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only.", +"type": "boolean" +}, "ipCidrRange": { "description": "The IP address range, in CIDR format, represented by this sub public delegated prefix.", "type": "string" @@ -108040,7 +108093,7 @@ false "type": "object" }, "Snapshot": { -"description": "Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. LINT.IfChange", +"description": "Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots.", "id": "Snapshot", "properties": { "architecture": { diff --git a/googleapiclient/discovery_cache/documents/compute.beta.json b/googleapiclient/discovery_cache/documents/compute.beta.json index fb5215c1fb1..6886f713694 100644 --- a/googleapiclient/discovery_cache/documents/compute.beta.json +++ b/googleapiclient/discovery_cache/documents/compute.beta.json @@ -27051,6 +27051,366 @@ } } }, +"regionHealthSources": { +"methods": { +"aggregatedList": { +"description": "Retrieves the list of all HealthSource resources (all regional) available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", +"flatPath": "projects/{project}/aggregated/healthSources", +"httpMethod": "GET", +"id": "compute.regionHealthSources.aggregatedList", +"parameterOrder": [ +"project" +], +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", +"location": "query", +"type": "string" +}, +"includeAllScopes": { +"description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", +"location": "query", +"type": "boolean" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", +"location": "query", +"type": "string" +}, +"project": { +"description": "Name of the project scoping this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", +"location": "query", +"type": "boolean" +}, +"serviceProjectNumber": { +"description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/aggregated/healthSources", +"response": { +"$ref": "HealthSourceAggregatedList" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"delete": { +"description": "Deletes the specified HealthSource in the given region", +"flatPath": "projects/{project}/regions/{region}/healthSources/{healthSource}", +"httpMethod": "DELETE", +"id": "compute.regionHealthSources.delete", +"parameterOrder": [ +"project", +"region", +"healthSource" +], +"parameters": { +"healthSource": { +"description": "Name of the HealthSource 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" +}, +"region": { +"description": "Name of the region scoping this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/healthSources/{healthSource}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"get": { +"description": "Returns the specified HealthSource resource in the given region.", +"flatPath": "projects/{project}/regions/{region}/healthSources/{healthSource}", +"httpMethod": "GET", +"id": "compute.regionHealthSources.get", +"parameterOrder": [ +"project", +"region", +"healthSource" +], +"parameters": { +"healthSource": { +"description": "Name of the HealthSource 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" +}, +"region": { +"description": "Name of the region scoping this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/healthSources/{healthSource}", +"response": { +"$ref": "HealthSource" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"insert": { +"description": "Create a HealthSource in the specified project in the given region using the parameters that are included in the request.", +"flatPath": "projects/{project}/regions/{region}/healthSources", +"httpMethod": "POST", +"id": "compute.regionHealthSources.insert", +"parameterOrder": [ +"project", +"region" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region scoping this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/healthSources", +"request": { +"$ref": "HealthSource" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"list": { +"description": "Lists the HealthSources for a project in the given region.", +"flatPath": "projects/{project}/regions/{region}/healthSources", +"httpMethod": "GET", +"id": "compute.regionHealthSources.list", +"parameterOrder": [ +"project", +"region" +], +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", +"location": "query", +"type": "string" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", +"location": "query", +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region scoping this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", +"location": "query", +"type": "boolean" +} +}, +"path": "projects/{project}/regions/{region}/healthSources", +"response": { +"$ref": "HealthSourceList" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"patch": { +"description": "Updates the specified regional HealthSource resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.", +"flatPath": "projects/{project}/regions/{region}/healthSources/{healthSource}", +"httpMethod": "PATCH", +"id": "compute.regionHealthSources.patch", +"parameterOrder": [ +"project", +"region", +"healthSource" +], +"parameters": { +"healthSource": { +"description": "Name of the HealthSource to update. The name must be 1-63 characters long, and comply with RFC1035.", +"location": "path", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region scoping this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/healthSources/{healthSource}", +"request": { +"$ref": "HealthSource" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified resource.", +"flatPath": "projects/{project}/regions/{region}/healthSources/{resource}/testIamPermissions", +"httpMethod": "POST", +"id": "compute.regionHealthSources.testIamPermissions", +"parameterOrder": [ +"project", +"region", +"resource" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "The name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"resource": { +"description": "Name or id of the resource for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/healthSources/{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" +] +} +} +}, "regionInstanceGroupManagerResizeRequests": { "methods": { "cancel": { @@ -31086,21 +31446,21 @@ } } }, -"regionNotificationEndpoints": { +"regionNetworkPolicies": { "methods": { -"delete": { -"description": "Deletes the specified NotificationEndpoint in the given region", -"flatPath": "projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}", -"httpMethod": "DELETE", -"id": "compute.regionNotificationEndpoints.delete", +"addAssociation": { +"description": "Inserts an association for the specified network policy.", +"flatPath": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/addAssociation", +"httpMethod": "POST", +"id": "compute.regionNetworkPolicies.addAssociation", "parameterOrder": [ "project", "region", -"notificationEndpoint" +"networkPolicy" ], "parameters": { -"notificationEndpoint": { -"description": "Name of the NotificationEndpoint resource to delete.", +"networkPolicy": { +"description": "Name of the network policy resource to update.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -31114,7 +31474,7 @@ "type": "string" }, "region": { -"description": "Name of the region scoping this request.", +"description": "Name of the region of this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, @@ -31126,7 +31486,10 @@ "type": "string" } }, -"path": "projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}", +"path": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/addAssociation", +"request": { +"$ref": "NetworkPolicyAssociation" +}, "response": { "$ref": "Operation" }, @@ -31135,19 +31498,19 @@ "https://www.googleapis.com/auth/compute" ] }, -"get": { -"description": "Returns the specified NotificationEndpoint resource in the given region.", -"flatPath": "projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}", -"httpMethod": "GET", -"id": "compute.regionNotificationEndpoints.get", +"addTrafficClassificationRule": { +"description": "Inserts a rule into a network policy.", +"flatPath": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/addTrafficClassificationRule", +"httpMethod": "POST", +"id": "compute.regionNetworkPolicies.addTrafficClassificationRule", "parameterOrder": [ "project", "region", -"notificationEndpoint" +"networkPolicy" ], "parameters": { -"notificationEndpoint": { -"description": "Name of the NotificationEndpoint resource to return.", +"networkPolicy": { +"description": "Name of the network policy resource to update.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -31161,42 +31524,7 @@ "type": "string" }, "region": { -"description": "Name of the region scoping this request.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", -"required": true, -"type": "string" -} -}, -"path": "projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}", -"response": { -"$ref": "NotificationEndpoint" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" -] -}, -"insert": { -"description": "Create a NotificationEndpoint in the specified project in the given region using the parameters that are included in the request.", -"flatPath": "projects/{project}/regions/{region}/notificationEndpoints", -"httpMethod": "POST", -"id": "compute.regionNotificationEndpoints.insert", -"parameterOrder": [ -"project", -"region" -], -"parameters": { -"project": { -"description": "Project ID for this request.", -"location": "path", -"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", -"required": true, -"type": "string" -}, -"region": { -"description": "Name of the region scoping this request.", +"description": "Name of the region of this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, @@ -31208,9 +31536,9 @@ "type": "string" } }, -"path": "projects/{project}/regions/{region}/notificationEndpoints", +"path": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/addTrafficClassificationRule", "request": { -"$ref": "NotificationEndpoint" +"$ref": "NetworkPolicyTrafficClassificationRule" }, "response": { "$ref": "Operation" @@ -31220,14 +31548,13 @@ "https://www.googleapis.com/auth/compute" ] }, -"list": { -"description": "Lists the NotificationEndpoints for a project in the given region.", -"flatPath": "projects/{project}/regions/{region}/notificationEndpoints", +"aggregatedList": { +"description": "Retrieves an aggregated list of network policies. To prevent failure, it's recommended that you set the `returnPartialSuccess` parameter to `true`.", +"flatPath": "projects/{project}/aggregated/networkPolicies", "httpMethod": "GET", -"id": "compute.regionNotificationEndpoints.list", +"id": "compute.regionNetworkPolicies.aggregatedList", "parameterOrder": [ -"project", -"region" +"project" ], "parameters": { "filter": { @@ -31235,6 +31562,11 @@ "location": "query", "type": "string" }, +"includeAllScopes": { +"description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", +"location": "query", +"type": "boolean" +}, "maxResults": { "default": "500", "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", @@ -31260,22 +31592,21 @@ "required": true, "type": "string" }, -"region": { -"description": "Name of the region scoping this request.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", -"required": true, -"type": "string" -}, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" +}, +"serviceProjectNumber": { +"description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", +"format": "int64", +"location": "query", +"type": "string" } }, -"path": "projects/{project}/regions/{region}/notificationEndpoints", +"path": "projects/{project}/aggregated/networkPolicies", "response": { -"$ref": "NotificationEndpointList" +"$ref": "NetworkPolicyAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -31283,17 +31614,24 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, -"testIamPermissions": { -"description": "Returns permissions that a caller has on the specified resource.", -"flatPath": "projects/{project}/regions/{region}/notificationEndpoints/{resource}/testIamPermissions", -"httpMethod": "POST", -"id": "compute.regionNotificationEndpoints.testIamPermissions", +"delete": { +"description": "Deletes the specified policy.", +"flatPath": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}", +"httpMethod": "DELETE", +"id": "compute.regionNetworkPolicies.delete", "parameterOrder": [ "project", "region", -"resource" +"networkPolicy" ], "parameters": { +"networkPolicy": { +"description": "Name of the network policy 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", @@ -31302,50 +31640,88 @@ "type": "string" }, "region": { -"description": "The name of the region for this request.", +"description": "Name of the region of this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, -"resource": { -"description": "Name or id of the resource for this request.", +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"get": { +"description": "Returns the specified network policy.", +"flatPath": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}", +"httpMethod": "GET", +"id": "compute.regionNetworkPolicies.get", +"parameterOrder": [ +"project", +"region", +"networkPolicy" +], +"parameters": { +"networkPolicy": { +"description": "Name of the network 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" -} }, -"path": "projects/{project}/regions/{region}/notificationEndpoints/{resource}/testIamPermissions", -"request": { -"$ref": "TestPermissionsRequest" +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region of this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} }, +"path": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}", "response": { -"$ref": "TestPermissionsResponse" +"$ref": "NetworkPolicy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ] -} -} }, -"regionOperations": { -"methods": { -"delete": { -"description": "Deletes the specified region-specific Operations resource.", -"flatPath": "projects/{project}/regions/{region}/operations/{operation}", -"httpMethod": "DELETE", -"id": "compute.regionOperations.delete", +"getAssociation": { +"description": "Gets an association with the specified name.", +"flatPath": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/getAssociation", +"httpMethod": "GET", +"id": "compute.regionNetworkPolicies.getAssociation", "parameterOrder": [ "project", "region", -"operation" +"networkPolicy" ], "parameters": { -"operation": { -"description": "Name of the Operations resource to delete, or its unique numeric identifier.", +"name": { +"description": "The name of the association to get from the network policy.", +"location": "query", +"type": "string" +}, +"networkPolicy": { +"description": "Name of the network policy to which the queried association belongs.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -31359,37 +31735,47 @@ "type": "string" }, "region": { -"description": "Name of the region for this request.", +"description": "Name of the region of this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" } }, -"path": "projects/{project}/regions/{region}/operations/{operation}", +"path": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/getAssociation", +"response": { +"$ref": "NetworkPolicyAssociation" +}, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute" +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" ] }, -"get": { -"description": "Retrieves the specified region-specific Operations resource.", -"flatPath": "projects/{project}/regions/{region}/operations/{operation}", +"getTrafficClassificationRule": { +"description": "Gets a rule of the specified priority.", +"flatPath": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/getTrafficClassificationRule", "httpMethod": "GET", -"id": "compute.regionOperations.get", +"id": "compute.regionNetworkPolicies.getTrafficClassificationRule", "parameterOrder": [ "project", "region", -"operation" +"networkPolicy" ], "parameters": { -"operation": { -"description": "Name of the Operations resource to return, or its unique numeric identifier.", +"networkPolicy": { +"description": "Name of the network policy to which the queried rule belongs.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" }, +"priority": { +"description": "The priority of the rule to get from the network policy.", +"format": "int32", +"location": "query", +"type": "integer" +}, "project": { "description": "Project ID for this request.", "location": "path", @@ -31398,16 +31784,16 @@ "type": "string" }, "region": { -"description": "Name of the region for this request.", +"description": "Name of the region of this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" } }, -"path": "projects/{project}/regions/{region}/operations/{operation}", +"path": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/getTrafficClassificationRule", "response": { -"$ref": "Operation" +"$ref": "NetworkPolicyTrafficClassificationRule" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -31415,11 +31801,53 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, +"insert": { +"description": "Creates a new policy in the specified project using the data included in the request.", +"flatPath": "projects/{project}/regions/{region}/networkPolicies", +"httpMethod": "POST", +"id": "compute.regionNetworkPolicies.insert", +"parameterOrder": [ +"project", +"region" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region of this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/networkPolicies", +"request": { +"$ref": "NetworkPolicy" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, "list": { -"description": "Retrieves a list of Operation resources contained within the specified region.", -"flatPath": "projects/{project}/regions/{region}/operations", +"description": "Lists all the policies that have been configured for the specified project in the given region.", +"flatPath": "projects/{project}/regions/{region}/networkPolicies", "httpMethod": "GET", -"id": "compute.regionOperations.list", +"id": "compute.regionNetworkPolicies.list", "parameterOrder": [ "project", "region" @@ -31456,7 +31884,7 @@ "type": "string" }, "region": { -"description": "Name of the region for this request.", +"description": "Name of the region of this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, @@ -31468,9 +31896,9 @@ "type": "boolean" } }, -"path": "projects/{project}/regions/{region}/operations", +"path": "projects/{project}/regions/{region}/networkPolicies", "response": { -"$ref": "OperationList" +"$ref": "NetworkPolicyList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -31478,19 +31906,19 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, -"wait": { -"description": "Waits for the specified Operation resource to return as `DONE` or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the `GET` method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be `DONE` or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not `DONE`. ", -"flatPath": "projects/{project}/regions/{region}/operations/{operation}/wait", -"httpMethod": "POST", -"id": "compute.regionOperations.wait", +"patch": { +"description": "Patches the specified policy with the data included in the request.", +"flatPath": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}", +"httpMethod": "PATCH", +"id": "compute.regionNetworkPolicies.patch", "parameterOrder": [ "project", "region", -"operation" +"networkPolicy" ], "parameters": { -"operation": { -"description": "Name of the Operations resource to return, or its unique numeric identifier.", +"networkPolicy": { +"description": "Name of the network policy resource to update.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -31504,38 +31932,54 @@ "type": "string" }, "region": { -"description": "Name of the region for this request.", +"description": "Name of the region of this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" } }, -"path": "projects/{project}/regions/{region}/operations/{operation}/wait", +"path": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}", +"request": { +"$ref": "NetworkPolicy" +}, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] -} -} }, -"regionSecurityPolicies": { -"methods": { -"addRule": { -"description": "Inserts a rule into a security policy.", -"flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/addRule", +"patchTrafficClassificationRule": { +"description": "Patches a rule of the specified priority.", +"flatPath": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/patchTrafficClassificationRule", "httpMethod": "POST", -"id": "compute.regionSecurityPolicies.addRule", +"id": "compute.regionNetworkPolicies.patchTrafficClassificationRule", "parameterOrder": [ "project", "region", -"securityPolicy" +"networkPolicy" ], "parameters": { +"networkPolicy": { +"description": "Name of the network policy 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" +}, +"priority": { +"description": "The priority of the traffic classification rule to patch. Only rules with a priority value between 1 and 2147482647 (inclusive) can be patched.", +"format": "int32", +"location": "query", +"type": "integer" +}, "project": { "description": "Project ID for this request.", "location": "path", @@ -31544,28 +31988,21 @@ "type": "string" }, "region": { -"description": "Name of the region scoping this request.", +"description": "Name of the region of this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, -"securityPolicy": { -"description": "Name of the security policy 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" -}, -"validateOnly": { -"description": "If true, the request will not be committed.", +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", -"type": "boolean" +"type": "string" } }, -"path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/addRule", +"path": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/patchTrafficClassificationRule", "request": { -"$ref": "SecurityPolicyRule" +"$ref": "NetworkPolicyTrafficClassificationRule" }, "response": { "$ref": "Operation" @@ -31575,17 +32012,29 @@ "https://www.googleapis.com/auth/compute" ] }, -"delete": { -"description": "Deletes the specified policy.", -"flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", -"httpMethod": "DELETE", -"id": "compute.regionSecurityPolicies.delete", +"removeAssociation": { +"description": "Removes an association for the specified network policy.", +"flatPath": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/removeAssociation", +"httpMethod": "POST", +"id": "compute.regionNetworkPolicies.removeAssociation", "parameterOrder": [ "project", "region", -"securityPolicy" +"networkPolicy" ], "parameters": { +"name": { +"description": "Name for the association that will be removed.", +"location": "query", +"type": "string" +}, +"networkPolicy": { +"description": "Name of the network policy 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", @@ -31594,7 +32043,7 @@ "type": "string" }, "region": { -"description": "Name of the region scoping this request.", +"description": "Name of the region of this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, @@ -31604,16 +32053,62 @@ "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" +} }, -"securityPolicy": { -"description": "Name of the security policy to delete.", +"path": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/removeAssociation", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"removeTrafficClassificationRule": { +"description": "Deletes a rule of the specified priority.", +"flatPath": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/removeTrafficClassificationRule", +"httpMethod": "POST", +"id": "compute.regionNetworkPolicies.removeTrafficClassificationRule", +"parameterOrder": [ +"project", +"region", +"networkPolicy" +], +"parameters": { +"networkPolicy": { +"description": "Name of the network policy 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" +}, +"priority": { +"description": "The priority of the rule to remove from the network policy.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region of this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" } }, -"path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", +"path": "projects/{project}/regions/{region}/networkPolicies/{networkPolicy}/removeTrafficClassificationRule", "response": { "$ref": "Operation" }, @@ -31621,18 +32116,29 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] +} +} }, -"get": { -"description": "List all of the ordered rules present in a single specified policy.", -"flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", -"httpMethod": "GET", -"id": "compute.regionSecurityPolicies.get", +"regionNotificationEndpoints": { +"methods": { +"delete": { +"description": "Deletes the specified NotificationEndpoint in the given region", +"flatPath": "projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}", +"httpMethod": "DELETE", +"id": "compute.regionNotificationEndpoints.delete", "parameterOrder": [ "project", "region", -"securityPolicy" +"notificationEndpoint" ], "parameters": { +"notificationEndpoint": { +"description": "Name of the NotificationEndpoint 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", @@ -31647,40 +32153,38 @@ "required": true, "type": "string" }, -"securityPolicy": { -"description": "Name of the security policy to get.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", -"required": true, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", "type": "string" } }, -"path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", +"path": "projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}", "response": { -"$ref": "SecurityPolicy" +"$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] }, -"getRule": { -"description": "Gets a rule at the specified priority.", -"flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/getRule", +"get": { +"description": "Returns the specified NotificationEndpoint resource in the given region.", +"flatPath": "projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}", "httpMethod": "GET", -"id": "compute.regionSecurityPolicies.getRule", +"id": "compute.regionNotificationEndpoints.get", "parameterOrder": [ "project", "region", -"securityPolicy" +"notificationEndpoint" ], "parameters": { -"priority": { -"description": "The priority of the rule to get from the security policy.", -"format": "int32", -"location": "query", -"type": "integer" +"notificationEndpoint": { +"description": "Name of the NotificationEndpoint 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.", @@ -31695,18 +32199,11 @@ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" -}, -"securityPolicy": { -"description": "Name of the security policy to which the queried rule belongs.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", -"required": true, -"type": "string" } }, -"path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/getRule", +"path": "projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}", "response": { -"$ref": "SecurityPolicyRule" +"$ref": "NotificationEndpoint" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -31715,10 +32212,10 @@ ] }, "insert": { -"description": "Creates a new policy in the specified project using the data included in the request.", -"flatPath": "projects/{project}/regions/{region}/securityPolicies", +"description": "Create a NotificationEndpoint in the specified project in the given region using the parameters that are included in the request.", +"flatPath": "projects/{project}/regions/{region}/notificationEndpoints", "httpMethod": "POST", -"id": "compute.regionSecurityPolicies.insert", +"id": "compute.regionNotificationEndpoints.insert", "parameterOrder": [ "project", "region" @@ -31742,16 +32239,11 @@ "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" -}, -"validateOnly": { -"description": "If true, the request will not be committed.", -"location": "query", -"type": "boolean" } }, -"path": "projects/{project}/regions/{region}/securityPolicies", +"path": "projects/{project}/regions/{region}/notificationEndpoints", "request": { -"$ref": "SecurityPolicy" +"$ref": "NotificationEndpoint" }, "response": { "$ref": "Operation" @@ -31762,10 +32254,10 @@ ] }, "list": { -"description": "List all the policies that have been configured for the specified project and region.", -"flatPath": "projects/{project}/regions/{region}/securityPolicies", +"description": "Lists the NotificationEndpoints for a project in the given region.", +"flatPath": "projects/{project}/regions/{region}/notificationEndpoints", "httpMethod": "GET", -"id": "compute.regionSecurityPolicies.list", +"id": "compute.regionNotificationEndpoints.list", "parameterOrder": [ "project", "region" @@ -31814,9 +32306,9 @@ "type": "boolean" } }, -"path": "projects/{project}/regions/{region}/securityPolicies", +"path": "projects/{project}/regions/{region}/notificationEndpoints", "response": { -"$ref": "SecurityPolicyList" +"$ref": "NotificationEndpointList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -31824,15 +32316,15 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, -"patch": { -"description": "Patches the specified policy with the data included in the request. To clear fields in the policy, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead.", -"flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", -"httpMethod": "PATCH", -"id": "compute.regionSecurityPolicies.patch", +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified resource.", +"flatPath": "projects/{project}/regions/{region}/notificationEndpoints/{resource}/testIamPermissions", +"httpMethod": "POST", +"id": "compute.regionNotificationEndpoints.testIamPermissions", "parameterOrder": [ "project", "region", -"securityPolicy" +"resource" ], "parameters": { "project": { @@ -31843,59 +32335,54 @@ "type": "string" }, "region": { -"description": "Name of the region scoping this request.", +"description": "The name of the region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, -"requestId": { -"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", -"location": "query", -"type": "string" -}, -"securityPolicy": { -"description": "Name of the security policy to update.", +"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" -}, -"updateMask": { -"description": "Indicates fields to be cleared as part of this request.", -"format": "google-fieldmask", -"location": "query", -"type": "string" } }, -"path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", +"path": "projects/{project}/regions/{region}/notificationEndpoints/{resource}/testIamPermissions", "request": { -"$ref": "SecurityPolicy" +"$ref": "TestPermissionsRequest" }, "response": { -"$ref": "Operation" +"$ref": "TestPermissionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute" +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" ] +} +} }, -"patchRule": { -"description": "Patches a rule at the specified priority. To clear fields in the rule, leave the fields empty and specify them in the updateMask.", -"flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/patchRule", -"httpMethod": "POST", -"id": "compute.regionSecurityPolicies.patchRule", +"regionOperations": { +"methods": { +"delete": { +"description": "Deletes the specified region-specific Operations resource.", +"flatPath": "projects/{project}/regions/{region}/operations/{operation}", +"httpMethod": "DELETE", +"id": "compute.regionOperations.delete", "parameterOrder": [ "project", "region", -"securityPolicy" +"operation" ], "parameters": { -"priority": { -"description": "The priority of the rule to patch.", -"format": "int32", -"location": "query", -"type": "integer" +"operation": { +"description": "Name of the Operations resource to delete, or its unique numeric identifier.", +"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.", @@ -31905,59 +32392,36 @@ "type": "string" }, "region": { -"description": "Name of the region scoping this request.", +"description": "Name of the region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" -}, -"securityPolicy": { -"description": "Name of the security policy 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" -}, -"updateMask": { -"description": "Indicates fields to be cleared as part of this request.", -"format": "google-fieldmask", -"location": "query", -"type": "string" -}, -"validateOnly": { -"description": "If true, the request will not be committed.", -"location": "query", -"type": "boolean" } }, -"path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/patchRule", -"request": { -"$ref": "SecurityPolicyRule" -}, -"response": { -"$ref": "Operation" -}, +"path": "projects/{project}/regions/{region}/operations/{operation}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] }, -"removeRule": { -"description": "Deletes a rule at the specified priority.", -"flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/removeRule", -"httpMethod": "POST", -"id": "compute.regionSecurityPolicies.removeRule", +"get": { +"description": "Retrieves the specified region-specific Operations resource.", +"flatPath": "projects/{project}/regions/{region}/operations/{operation}", +"httpMethod": "GET", +"id": "compute.regionOperations.get", "parameterOrder": [ "project", "region", -"securityPolicy" +"operation" ], "parameters": { -"priority": { -"description": "The priority of the rule to remove from the security policy.", -"format": "int32", -"location": "query", -"type": "integer" +"operation": { +"description": "Name of the Operations resource to return, or its unique numeric identifier.", +"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.", @@ -31967,40 +32431,56 @@ "type": "string" }, "region": { -"description": "Name of the region scoping this request.", +"description": "Name of the region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" -}, -"securityPolicy": { -"description": "Name of the security policy to update.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", -"required": true, -"type": "string" } }, -"path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/removeRule", +"path": "projects/{project}/regions/{region}/operations/{operation}", "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute" +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" ] }, -"setLabels": { -"description": "Sets the labels on a security policy. To learn more about labels, read the Labeling Resources documentation.", -"flatPath": "projects/{project}/regions/{region}/securityPolicies/{resource}/setLabels", -"httpMethod": "POST", -"id": "compute.regionSecurityPolicies.setLabels", +"list": { +"description": "Retrieves a list of Operation resources contained within the specified region.", +"flatPath": "projects/{project}/regions/{region}/operations", +"httpMethod": "GET", +"id": "compute.regionOperations.list", "parameterOrder": [ "project", -"region", -"resource" +"region" ], "parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", +"location": "query", +"type": "string" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", +"location": "query", +"type": "string" +}, "project": { "description": "Project ID for this request.", "location": "path", @@ -32009,51 +32489,46 @@ "type": "string" }, "region": { -"description": "The region for this request.", +"description": "Name of the region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, -"requestId": { -"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", -"type": "string" -}, -"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" +"type": "boolean" } }, -"path": "projects/{project}/regions/{region}/securityPolicies/{resource}/setLabels", -"request": { -"$ref": "RegionSetLabelsRequest" -}, +"path": "projects/{project}/regions/{region}/operations", "response": { -"$ref": "Operation" +"$ref": "OperationList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute" +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" ] -} -} }, -"regionSnapshotSettings": { -"methods": { -"get": { -"description": "Get region snapshot settings.", -"flatPath": "projects/{project}/regions/{region}/snapshotSettings", -"httpMethod": "GET", -"id": "compute.regionSnapshotSettings.get", +"wait": { +"description": "Waits for the specified Operation resource to return as `DONE` or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the `GET` method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be `DONE` or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not `DONE`. ", +"flatPath": "projects/{project}/regions/{region}/operations/{operation}/wait", +"httpMethod": "POST", +"id": "compute.regionOperations.wait", "parameterOrder": [ "project", -"region" +"region", +"operation" ], "parameters": { +"operation": { +"description": "Name of the Operations resource to return, or its unique numeric identifier.", +"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", @@ -32069,24 +32544,29 @@ "type": "string" } }, -"path": "projects/{project}/regions/{region}/snapshotSettings", +"path": "projects/{project}/regions/{region}/operations/{operation}/wait", "response": { -"$ref": "SnapshotSettings" +"$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ] +} +} }, -"patch": { -"description": "Patch region snapshot settings.", -"flatPath": "projects/{project}/regions/{region}/snapshotSettings", -"httpMethod": "PATCH", -"id": "compute.regionSnapshotSettings.patch", +"regionSecurityPolicies": { +"methods": { +"addRule": { +"description": "Inserts a rule into a security policy.", +"flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/addRule", +"httpMethod": "POST", +"id": "compute.regionSecurityPolicies.addRule", "parameterOrder": [ "project", -"region" +"region", +"securityPolicy" ], "parameters": { "project": { @@ -32097,27 +32577,28 @@ "type": "string" }, "region": { -"description": "Name of the region for this request.", +"description": "Name of the region scoping this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, -"requestId": { -"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", -"location": "query", +"securityPolicy": { +"description": "Name of the security policy 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" }, -"updateMask": { -"description": "update_mask indicates fields to be updated as part of this request.", -"format": "google-fieldmask", +"validateOnly": { +"description": "If true, the request will not be committed.", "location": "query", -"type": "string" +"type": "boolean" } }, -"path": "projects/{project}/regions/{region}/snapshotSettings", +"path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/addRule", "request": { -"$ref": "SnapshotSettings" +"$ref": "SecurityPolicyRule" }, "response": { "$ref": "Operation" @@ -32126,20 +32607,16 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] -} -} }, -"regionSnapshots": { -"methods": { "delete": { -"description": "Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot. For more information, see Deleting snapshots.", -"flatPath": "projects/{project}/regions/{region}/snapshots/{snapshot}", +"description": "Deletes the specified policy.", +"flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", "httpMethod": "DELETE", -"id": "compute.regionSnapshots.delete", +"id": "compute.regionSecurityPolicies.delete", "parameterOrder": [ "project", "region", -"snapshot" +"securityPolicy" ], "parameters": { "project": { @@ -32150,7 +32627,7 @@ "type": "string" }, "region": { -"description": "The name of the region for this request.", +"description": "Name of the region scoping this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, @@ -32161,15 +32638,15 @@ "location": "query", "type": "string" }, -"snapshot": { -"description": "Name of the snapshot resource to delete.", +"securityPolicy": { +"description": "Name of the security policy to delete.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, -"path": "projects/{project}/regions/{region}/snapshots/{snapshot}", +"path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", "response": { "$ref": "Operation" }, @@ -32179,14 +32656,14 @@ ] }, "get": { -"description": "Returns the specified Snapshot resource.", -"flatPath": "projects/{project}/regions/{region}/snapshots/{snapshot}", +"description": "List all of the ordered rules present in a single specified policy.", +"flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", "httpMethod": "GET", -"id": "compute.regionSnapshots.get", +"id": "compute.regionSecurityPolicies.get", "parameterOrder": [ "project", "region", -"snapshot" +"securityPolicy" ], "parameters": { "project": { @@ -32197,23 +32674,23 @@ "type": "string" }, "region": { -"description": "Name of the region for this request.", +"description": "Name of the region scoping this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, -"snapshot": { -"description": "Name of the Snapshot resource to return.", +"securityPolicy": { +"description": "Name of the security policy to get.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, -"path": "projects/{project}/regions/{region}/snapshots/{snapshot}", +"path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", "response": { -"$ref": "Snapshot" +"$ref": "SecurityPolicy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -32221,19 +32698,19 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, -"getIamPolicy": { -"description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.", -"flatPath": "projects/{project}/regions/{region}/snapshots/{resource}/getIamPolicy", +"getRule": { +"description": "Gets a rule at the specified priority.", +"flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/getRule", "httpMethod": "GET", -"id": "compute.regionSnapshots.getIamPolicy", +"id": "compute.regionSecurityPolicies.getRule", "parameterOrder": [ "project", "region", -"resource" +"securityPolicy" ], "parameters": { -"optionsRequestedPolicyVersion": { -"description": "Requested IAM Policy version.", +"priority": { +"description": "The priority of the rule to get from the security policy.", "format": "int32", "location": "query", "type": "integer" @@ -32246,23 +32723,23 @@ "type": "string" }, "region": { -"description": "The name of the region for this request.", +"description": "Name of the region scoping this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, -"resource": { -"description": "Name or id of the resource for this request.", +"securityPolicy": { +"description": "Name of the security policy to which the queried rule belongs.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, -"path": "projects/{project}/regions/{region}/snapshots/{resource}/getIamPolicy", +"path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/getRule", "response": { -"$ref": "Policy" +"$ref": "SecurityPolicyRule" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -32271,10 +32748,10 @@ ] }, "insert": { -"description": "Creates a snapshot in the specified region using the data included in the request.", -"flatPath": "projects/{project}/regions/{region}/snapshots", +"description": "Creates a new policy in the specified project using the data included in the request.", +"flatPath": "projects/{project}/regions/{region}/securityPolicies", "httpMethod": "POST", -"id": "compute.regionSnapshots.insert", +"id": "compute.regionSecurityPolicies.insert", "parameterOrder": [ "project", "region" @@ -32288,7 +32765,7 @@ "type": "string" }, "region": { -"description": "Name of the region for this request.", +"description": "Name of the region scoping this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, @@ -32298,11 +32775,16 @@ "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" +}, +"validateOnly": { +"description": "If true, the request will not be committed.", +"location": "query", +"type": "boolean" } }, -"path": "projects/{project}/regions/{region}/snapshots", +"path": "projects/{project}/regions/{region}/securityPolicies", "request": { -"$ref": "Snapshot" +"$ref": "SecurityPolicy" }, "response": { "$ref": "Operation" @@ -32313,10 +32795,10 @@ ] }, "list": { -"description": "Retrieves the list of Snapshot resources contained within the specified region.", -"flatPath": "projects/{project}/regions/{region}/snapshots", +"description": "List all the policies that have been configured for the specified project and region.", +"flatPath": "projects/{project}/regions/{region}/securityPolicies", "httpMethod": "GET", -"id": "compute.regionSnapshots.list", +"id": "compute.regionSecurityPolicies.list", "parameterOrder": [ "project", "region" @@ -32353,7 +32835,7 @@ "type": "string" }, "region": { -"description": "Name of the region for this request.", +"description": "Name of the region scoping this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, @@ -32365,9 +32847,9 @@ "type": "boolean" } }, -"path": "projects/{project}/regions/{region}/snapshots", +"path": "projects/{project}/regions/{region}/securityPolicies", "response": { -"$ref": "SnapshotList" +"$ref": "SecurityPolicyList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -32375,15 +32857,15 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, -"setIamPolicy": { -"description": "Sets the access control policy on the specified resource. Replaces any existing policy.", -"flatPath": "projects/{project}/regions/{region}/snapshots/{resource}/setIamPolicy", -"httpMethod": "POST", -"id": "compute.regionSnapshots.setIamPolicy", +"patch": { +"description": "Patches the specified policy with the data included in the request. To clear fields in the policy, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead.", +"flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", +"httpMethod": "PATCH", +"id": "compute.regionSecurityPolicies.patch", "parameterOrder": [ "project", "region", -"resource" +"securityPolicy" ], "parameters": { "project": { @@ -32394,43 +32876,60 @@ "type": "string" }, "region": { -"description": "The name of the region for this request.", +"description": "Name of the region scoping this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, -"resource": { -"description": "Name or id of the resource for this request.", +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"securityPolicy": { +"description": "Name of the security policy 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" +}, +"updateMask": { +"description": "Indicates fields to be cleared as part of this request.", +"format": "google-fieldmask", +"location": "query", +"type": "string" } }, -"path": "projects/{project}/regions/{region}/snapshots/{resource}/setIamPolicy", +"path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", "request": { -"$ref": "RegionSetPolicyRequest" +"$ref": "SecurityPolicy" }, "response": { -"$ref": "Policy" +"$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] }, -"setLabels": { -"description": "Sets the labels on a regional snapshot. To learn more about labels, read the Labeling Resources documentation.", -"flatPath": "projects/{project}/regions/{region}/snapshots/{resource}/setLabels", +"patchRule": { +"description": "Patches a rule at the specified priority. To clear fields in the rule, leave the fields empty and specify them in the updateMask.", +"flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/patchRule", "httpMethod": "POST", -"id": "compute.regionSnapshots.setLabels", +"id": "compute.regionSecurityPolicies.patchRule", "parameterOrder": [ "project", "region", -"resource" +"securityPolicy" ], "parameters": { +"priority": { +"description": "The priority of the rule to patch.", +"format": "int32", +"location": "query", +"type": "integer" +}, "project": { "description": "Project ID for this request.", "location": "path", @@ -32439,28 +32938,34 @@ "type": "string" }, "region": { -"description": "The region for this request.", +"description": "Name of the region scoping this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, -"requestId": { -"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", -"location": "query", -"type": "string" -}, -"resource": { -"description": "Name or id of the resource for this request.", +"securityPolicy": { +"description": "Name of the security policy 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" +}, +"updateMask": { +"description": "Indicates fields to be cleared as part of this request.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +}, +"validateOnly": { +"description": "If true, the request will not be committed.", +"location": "query", +"type": "boolean" } }, -"path": "projects/{project}/regions/{region}/snapshots/{resource}/setLabels", +"path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/patchRule", "request": { -"$ref": "RegionSetLabelsRequest" +"$ref": "SecurityPolicyRule" }, "response": { "$ref": "Operation" @@ -32470,17 +32975,23 @@ "https://www.googleapis.com/auth/compute" ] }, -"testIamPermissions": { -"description": "Returns permissions that a caller has on the specified resource.", -"flatPath": "projects/{project}/regions/{region}/snapshots/{resource}/testIamPermissions", +"removeRule": { +"description": "Deletes a rule at the specified priority.", +"flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/removeRule", "httpMethod": "POST", -"id": "compute.regionSnapshots.testIamPermissions", +"id": "compute.regionSecurityPolicies.removeRule", "parameterOrder": [ "project", "region", -"resource" +"securityPolicy" ], "parameters": { +"priority": { +"description": "The priority of the rule to remove from the security policy.", +"format": "int32", +"location": "query", +"type": "integer" +}, "project": { "description": "Project ID for this request.", "location": "path", @@ -32489,46 +33000,38 @@ "type": "string" }, "region": { -"description": "The name of the region for this request.", +"description": "Name of the region scoping this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, -"resource": { -"description": "Name or id of the resource for this request.", +"securityPolicy": { +"description": "Name of the security policy to update.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, -"path": "projects/{project}/regions/{region}/snapshots/{resource}/testIamPermissions", -"request": { -"$ref": "TestPermissionsRequest" -}, +"path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/removeRule", "response": { -"$ref": "TestPermissionsResponse" +"$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] -} -} }, -"regionSslCertificates": { -"methods": { -"delete": { -"description": "Deletes the specified SslCertificate resource in the region.", -"flatPath": "projects/{project}/regions/{region}/sslCertificates/{sslCertificate}", -"httpMethod": "DELETE", -"id": "compute.regionSslCertificates.delete", +"setLabels": { +"description": "Sets the labels on a security policy. To learn more about labels, read the Labeling Resources documentation.", +"flatPath": "projects/{project}/regions/{region}/securityPolicies/{resource}/setLabels", +"httpMethod": "POST", +"id": "compute.regionSecurityPolicies.setLabels", "parameterOrder": [ "project", "region", -"sslCertificate" +"resource" ], "parameters": { "project": { @@ -32539,7 +33042,7 @@ "type": "string" }, "region": { -"description": "Name of the region scoping this request.", +"description": "The region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, @@ -32550,15 +33053,18 @@ "location": "query", "type": "string" }, -"sslCertificate": { -"description": "Name of the SslCertificate resource to delete.", +"resource": { +"description": "Name or id of the resource for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, -"path": "projects/{project}/regions/{region}/sslCertificates/{sslCertificate}", +"path": "projects/{project}/regions/{region}/securityPolicies/{resource}/setLabels", +"request": { +"$ref": "RegionSetLabelsRequest" +}, "response": { "$ref": "Operation" }, @@ -32566,16 +33072,19 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] +} +} }, +"regionSnapshotSettings": { +"methods": { "get": { -"description": "Returns the specified SslCertificate resource in the specified region. Get a list of available SSL certificates by making a list() request.", -"flatPath": "projects/{project}/regions/{region}/sslCertificates/{sslCertificate}", +"description": "Get region snapshot settings.", +"flatPath": "projects/{project}/regions/{region}/snapshotSettings", "httpMethod": "GET", -"id": "compute.regionSslCertificates.get", +"id": "compute.regionSnapshotSettings.get", "parameterOrder": [ "project", -"region", -"sslCertificate" +"region" ], "parameters": { "project": { @@ -32586,23 +33095,16 @@ "type": "string" }, "region": { -"description": "Name of the region scoping this request.", +"description": "Name of the region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" -}, -"sslCertificate": { -"description": "Name of the SslCertificate resource to return.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", -"required": true, -"type": "string" } }, -"path": "projects/{project}/regions/{region}/sslCertificates/{sslCertificate}", +"path": "projects/{project}/regions/{region}/snapshotSettings", "response": { -"$ref": "SslCertificate" +"$ref": "SnapshotSettings" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -32610,11 +33112,11 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, -"insert": { -"description": "Creates a SslCertificate resource in the specified project and region using the data included in the request", -"flatPath": "projects/{project}/regions/{region}/sslCertificates", -"httpMethod": "POST", -"id": "compute.regionSslCertificates.insert", +"patch": { +"description": "Patch region snapshot settings.", +"flatPath": "projects/{project}/regions/{region}/snapshotSettings", +"httpMethod": "PATCH", +"id": "compute.regionSnapshotSettings.patch", "parameterOrder": [ "project", "region" @@ -32628,7 +33130,7 @@ "type": "string" }, "region": { -"description": "Name of the region scoping this request.", +"description": "Name of the region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, @@ -32638,11 +33140,17 @@ "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" +}, +"updateMask": { +"description": "update_mask indicates fields to be updated as part of this request.", +"format": "google-fieldmask", +"location": "query", +"type": "string" } }, -"path": "projects/{project}/regions/{region}/sslCertificates", +"path": "projects/{project}/regions/{region}/snapshotSettings", "request": { -"$ref": "SslCertificate" +"$ref": "SnapshotSettings" }, "response": { "$ref": "Operation" @@ -32651,129 +33159,67 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] +} +} }, -"list": { -"description": "Retrieves the list of SslCertificate resources available to the specified project in the specified region.", -"flatPath": "projects/{project}/regions/{region}/sslCertificates", -"httpMethod": "GET", -"id": "compute.regionSslCertificates.list", +"regionSnapshots": { +"methods": { +"delete": { +"description": "Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot. For more information, see Deleting snapshots.", +"flatPath": "projects/{project}/regions/{region}/snapshots/{snapshot}", +"httpMethod": "DELETE", +"id": "compute.regionSnapshots.delete", "parameterOrder": [ "project", -"region" +"region", +"snapshot" ], "parameters": { -"filter": { -"description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", -"location": "query", -"type": "string" -}, -"maxResults": { -"default": "500", -"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", -"format": "uint32", -"location": "query", -"minimum": "0", -"type": "integer" -}, -"orderBy": { -"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", -"location": "query", -"type": "string" -}, -"pageToken": { -"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", -"location": "query", -"type": "string" -}, -"project": { -"description": "Project ID for this request.", -"location": "path", -"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", -"required": true, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, "type": "string" }, "region": { -"description": "Name of the region scoping this request.", +"description": "The name of the region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, -"returnPartialSuccess": { -"description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", -"type": "boolean" -} -}, -"path": "projects/{project}/regions/{region}/sslCertificates", -"response": { -"$ref": "SslCertificateList" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" -] -}, -"testIamPermissions": { -"description": "Returns permissions that a caller has on the specified resource and region.", -"flatPath": "projects/{project}/regions/{region}/sslCertificates/{resource}/testIamPermissions", -"httpMethod": "POST", -"id": "compute.regionSslCertificates.testIamPermissions", -"parameterOrder": [ -"project", -"region", -"resource" -], -"parameters": { -"project": { -"description": "Project ID for this request.", -"location": "path", -"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", -"required": true, -"type": "string" -}, -"region": { -"description": "The name of the region for this request.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", -"required": true, "type": "string" }, -"resource": { -"description": "Name or id of the resource for this request.", +"snapshot": { +"description": "Name of the snapshot resource to delete.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, -"path": "projects/{project}/regions/{region}/sslCertificates/{resource}/testIamPermissions", -"request": { -"$ref": "TestPermissionsRequest" -}, +"path": "projects/{project}/regions/{region}/snapshots/{snapshot}", "response": { -"$ref": "TestPermissionsResponse" +"$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] -} -} }, -"regionSslPolicies": { -"methods": { -"delete": { -"description": "Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources.", -"flatPath": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}", -"httpMethod": "DELETE", -"id": "compute.regionSslPolicies.delete", +"get": { +"description": "Returns the specified Snapshot resource.", +"flatPath": "projects/{project}/regions/{region}/snapshots/{snapshot}", +"httpMethod": "GET", +"id": "compute.regionSnapshots.get", "parameterOrder": [ "project", "region", -"sslPolicy" +"snapshot" ], "parameters": { "project": { @@ -32784,44 +33230,47 @@ "type": "string" }, "region": { -"description": "Name of the region scoping this request.", +"description": "Name of the region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, -"requestId": { -"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", -"location": "query", -"type": "string" -}, -"sslPolicy": { -"description": "Name of the SSL policy to delete. The name must be 1-63 characters long, and comply with RFC1035.", +"snapshot": { +"description": "Name of the Snapshot resource to return.", "location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, -"path": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}", +"path": "projects/{project}/regions/{region}/snapshots/{snapshot}", "response": { -"$ref": "Operation" +"$ref": "Snapshot" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute" +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" ] }, -"get": { -"description": "Lists all of the ordered rules present in a single specified policy.", -"flatPath": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}", +"getIamPolicy": { +"description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.", +"flatPath": "projects/{project}/regions/{region}/snapshots/{resource}/getIamPolicy", "httpMethod": "GET", -"id": "compute.regionSslPolicies.get", +"id": "compute.regionSnapshots.getIamPolicy", "parameterOrder": [ "project", "region", -"sslPolicy" +"resource" ], "parameters": { +"optionsRequestedPolicyVersion": { +"description": "Requested IAM Policy version.", +"format": "int32", +"location": "query", +"type": "integer" +}, "project": { "description": "Project ID for this request.", "location": "path", @@ -32830,22 +33279,23 @@ "type": "string" }, "region": { -"description": "Name of the region scoping this request.", +"description": "The name of the region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, -"sslPolicy": { -"description": "Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035.", +"resource": { +"description": "Name or id of the resource for this request.", "location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, -"path": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}", +"path": "projects/{project}/regions/{region}/snapshots/{resource}/getIamPolicy", "response": { -"$ref": "SslPolicy" +"$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -32854,10 +33304,10 @@ ] }, "insert": { -"description": "Creates a new policy in the specified project and region using the data included in the request.", -"flatPath": "projects/{project}/regions/{region}/sslPolicies", +"description": "Creates a snapshot in the specified region using the data included in the request.", +"flatPath": "projects/{project}/regions/{region}/snapshots", "httpMethod": "POST", -"id": "compute.regionSslPolicies.insert", +"id": "compute.regionSnapshots.insert", "parameterOrder": [ "project", "region" @@ -32871,7 +33321,7 @@ "type": "string" }, "region": { -"description": "Name of the region scoping this request.", +"description": "Name of the region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, @@ -32883,9 +33333,9 @@ "type": "string" } }, -"path": "projects/{project}/regions/{region}/sslPolicies", +"path": "projects/{project}/regions/{region}/snapshots", "request": { -"$ref": "SslPolicy" +"$ref": "Snapshot" }, "response": { "$ref": "Operation" @@ -32896,10 +33346,10 @@ ] }, "list": { -"description": "Lists all the SSL policies that have been configured for the specified project and region.", -"flatPath": "projects/{project}/regions/{region}/sslPolicies", +"description": "Retrieves the list of Snapshot resources contained within the specified region.", +"flatPath": "projects/{project}/regions/{region}/snapshots", "httpMethod": "GET", -"id": "compute.regionSslPolicies.list", +"id": "compute.regionSnapshots.list", "parameterOrder": [ "project", "region" @@ -32936,7 +33386,7 @@ "type": "string" }, "region": { -"description": "Name of the region scoping this request.", +"description": "Name of the region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, @@ -32948,9 +33398,9 @@ "type": "boolean" } }, -"path": "projects/{project}/regions/{region}/sslPolicies", +"path": "projects/{project}/regions/{region}/snapshots", "response": { -"$ref": "SslPoliciesList" +"$ref": "SnapshotList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -32958,39 +33408,17 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, -"listAvailableFeatures": { -"description": "Lists all features that can be specified in the SSL policy when using custom profile.", -"flatPath": "projects/{project}/regions/{region}/sslPolicies/listAvailableFeatures", -"httpMethod": "GET", -"id": "compute.regionSslPolicies.listAvailableFeatures", +"setIamPolicy": { +"description": "Sets the access control policy on the specified resource. Replaces any existing policy.", +"flatPath": "projects/{project}/regions/{region}/snapshots/{resource}/setIamPolicy", +"httpMethod": "POST", +"id": "compute.regionSnapshots.setIamPolicy", "parameterOrder": [ "project", -"region" +"region", +"resource" ], "parameters": { -"filter": { -"description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", -"location": "query", -"type": "string" -}, -"maxResults": { -"default": "500", -"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", -"format": "uint32", -"location": "query", -"minimum": "0", -"type": "integer" -}, -"orderBy": { -"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", -"location": "query", -"type": "string" -}, -"pageToken": { -"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", -"location": "query", -"type": "string" -}, "project": { "description": "Project ID for this request.", "location": "path", @@ -32999,37 +33427,41 @@ "type": "string" }, "region": { -"description": "Name of the region scoping this request.", +"description": "The name of the region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, -"returnPartialSuccess": { -"description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", -"location": "query", -"type": "boolean" +"resource": { +"description": "Name or id of the resource for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" } }, -"path": "projects/{project}/regions/{region}/sslPolicies/listAvailableFeatures", +"path": "projects/{project}/regions/{region}/snapshots/{resource}/setIamPolicy", +"request": { +"$ref": "RegionSetPolicyRequest" +}, "response": { -"$ref": "SslPoliciesListAvailableFeaturesResponse" +"$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] }, -"patch": { -"description": "Patches the specified SSL policy with the data included in the request.", -"flatPath": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}", -"httpMethod": "PATCH", -"id": "compute.regionSslPolicies.patch", +"setLabels": { +"description": "Sets the labels on a regional snapshot. To learn more about labels, read the Labeling Resources documentation.", +"flatPath": "projects/{project}/regions/{region}/snapshots/{resource}/setLabels", +"httpMethod": "POST", +"id": "compute.regionSnapshots.setLabels", "parameterOrder": [ "project", "region", -"sslPolicy" +"resource" ], "parameters": { "project": { @@ -33040,7 +33472,7 @@ "type": "string" }, "region": { -"description": "Name of the region scoping this request.", +"description": "The region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, @@ -33051,16 +33483,17 @@ "location": "query", "type": "string" }, -"sslPolicy": { -"description": "Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035.", +"resource": { +"description": "Name or id of the resource for this request.", "location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, -"path": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}", +"path": "projects/{project}/regions/{region}/snapshots/{resource}/setLabels", "request": { -"$ref": "SslPolicy" +"$ref": "RegionSetLabelsRequest" }, "response": { "$ref": "Operation" @@ -33072,9 +33505,9 @@ }, "testIamPermissions": { "description": "Returns permissions that a caller has on the specified resource.", -"flatPath": "projects/{project}/regions/{region}/sslPolicies/{resource}/testIamPermissions", +"flatPath": "projects/{project}/regions/{region}/snapshots/{resource}/testIamPermissions", "httpMethod": "POST", -"id": "compute.regionSslPolicies.testIamPermissions", +"id": "compute.regionSnapshots.testIamPermissions", "parameterOrder": [ "project", "region", @@ -33103,7 +33536,7 @@ "type": "string" } }, -"path": "projects/{project}/regions/{region}/sslPolicies/{resource}/testIamPermissions", +"path": "projects/{project}/regions/{region}/snapshots/{resource}/testIamPermissions", "request": { "$ref": "TestPermissionsRequest" }, @@ -33118,17 +33551,17 @@ } } }, -"regionTargetHttpProxies": { +"regionSslCertificates": { "methods": { "delete": { -"description": "Deletes the specified TargetHttpProxy resource.", -"flatPath": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}", +"description": "Deletes the specified SslCertificate resource in the region.", +"flatPath": "projects/{project}/regions/{region}/sslCertificates/{sslCertificate}", "httpMethod": "DELETE", -"id": "compute.regionTargetHttpProxies.delete", +"id": "compute.regionSslCertificates.delete", "parameterOrder": [ "project", "region", -"targetHttpProxy" +"sslCertificate" ], "parameters": { "project": { @@ -33150,15 +33583,15 @@ "location": "query", "type": "string" }, -"targetHttpProxy": { -"description": "Name of the TargetHttpProxy resource to delete.", +"sslCertificate": { +"description": "Name of the SslCertificate resource to delete.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, -"path": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}", +"path": "projects/{project}/regions/{region}/sslCertificates/{sslCertificate}", "response": { "$ref": "Operation" }, @@ -33168,14 +33601,14 @@ ] }, "get": { -"description": "Returns the specified TargetHttpProxy resource in the specified region.", -"flatPath": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}", +"description": "Returns the specified SslCertificate resource in the specified region. Get a list of available SSL certificates by making a list() request.", +"flatPath": "projects/{project}/regions/{region}/sslCertificates/{sslCertificate}", "httpMethod": "GET", -"id": "compute.regionTargetHttpProxies.get", +"id": "compute.regionSslCertificates.get", "parameterOrder": [ "project", "region", -"targetHttpProxy" +"sslCertificate" ], "parameters": { "project": { @@ -33192,17 +33625,17 @@ "required": true, "type": "string" }, -"targetHttpProxy": { -"description": "Name of the TargetHttpProxy resource to return.", +"sslCertificate": { +"description": "Name of the SslCertificate resource to return.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, -"path": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}", +"path": "projects/{project}/regions/{region}/sslCertificates/{sslCertificate}", "response": { -"$ref": "TargetHttpProxy" +"$ref": "SslCertificate" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -33211,10 +33644,10 @@ ] }, "insert": { -"description": "Creates a TargetHttpProxy resource in the specified project and region using the data included in the request.", -"flatPath": "projects/{project}/regions/{region}/targetHttpProxies", +"description": "Creates a SslCertificate resource in the specified project and region using the data included in the request", +"flatPath": "projects/{project}/regions/{region}/sslCertificates", "httpMethod": "POST", -"id": "compute.regionTargetHttpProxies.insert", +"id": "compute.regionSslCertificates.insert", "parameterOrder": [ "project", "region" @@ -33240,9 +33673,9 @@ "type": "string" } }, -"path": "projects/{project}/regions/{region}/targetHttpProxies", +"path": "projects/{project}/regions/{region}/sslCertificates", "request": { -"$ref": "TargetHttpProxy" +"$ref": "SslCertificate" }, "response": { "$ref": "Operation" @@ -33253,10 +33686,10 @@ ] }, "list": { -"description": "Retrieves the list of TargetHttpProxy resources available to the specified project in the specified region.", -"flatPath": "projects/{project}/regions/{region}/targetHttpProxies", +"description": "Retrieves the list of SslCertificate resources available to the specified project in the specified region.", +"flatPath": "projects/{project}/regions/{region}/sslCertificates", "httpMethod": "GET", -"id": "compute.regionTargetHttpProxies.list", +"id": "compute.regionSslCertificates.list", "parameterOrder": [ "project", "region" @@ -33305,9 +33738,9 @@ "type": "boolean" } }, -"path": "projects/{project}/regions/{region}/targetHttpProxies", +"path": "projects/{project}/regions/{region}/sslCertificates", "response": { -"$ref": "TargetHttpProxyList" +"$ref": "SslCertificateList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -33315,61 +33748,11 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, -"setUrlMap": { -"description": "Changes the URL map for TargetHttpProxy.", -"flatPath": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}/setUrlMap", -"httpMethod": "POST", -"id": "compute.regionTargetHttpProxies.setUrlMap", -"parameterOrder": [ -"project", -"region", -"targetHttpProxy" -], -"parameters": { -"project": { -"description": "Project ID for this request.", -"location": "path", -"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", -"required": true, -"type": "string" -}, -"region": { -"description": "Name of the region scoping this request.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", -"required": true, -"type": "string" -}, -"requestId": { -"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", -"location": "query", -"type": "string" -}, -"targetHttpProxy": { -"description": "Name of the TargetHttpProxy to set a URL map for.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", -"required": true, -"type": "string" -} -}, -"path": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}/setUrlMap", -"request": { -"$ref": "UrlMapReference" -}, -"response": { -"$ref": "Operation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute" -] -}, "testIamPermissions": { -"description": "Returns permissions that a caller has on the specified resource.", -"flatPath": "projects/{project}/regions/{region}/targetHttpProxies/{resource}/testIamPermissions", +"description": "Returns permissions that a caller has on the specified resource and region.", +"flatPath": "projects/{project}/regions/{region}/sslCertificates/{resource}/testIamPermissions", "httpMethod": "POST", -"id": "compute.regionTargetHttpProxies.testIamPermissions", +"id": "compute.regionSslCertificates.testIamPermissions", "parameterOrder": [ "project", "region", @@ -33398,7 +33781,7 @@ "type": "string" } }, -"path": "projects/{project}/regions/{region}/targetHttpProxies/{resource}/testIamPermissions", +"path": "projects/{project}/regions/{region}/sslCertificates/{resource}/testIamPermissions", "request": { "$ref": "TestPermissionsRequest" }, @@ -33413,17 +33796,17 @@ } } }, -"regionTargetHttpsProxies": { +"regionSslPolicies": { "methods": { "delete": { -"description": "Deletes the specified TargetHttpsProxy resource.", -"flatPath": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}", +"description": "Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources.", +"flatPath": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}", "httpMethod": "DELETE", -"id": "compute.regionTargetHttpsProxies.delete", +"id": "compute.regionSslPolicies.delete", "parameterOrder": [ "project", "region", -"targetHttpsProxy" +"sslPolicy" ], "parameters": { "project": { @@ -33445,15 +33828,14 @@ "location": "query", "type": "string" }, -"targetHttpsProxy": { -"description": "Name of the TargetHttpsProxy resource to delete.", +"sslPolicy": { +"description": "Name of the SSL policy to delete. The name must be 1-63 characters long, and comply with RFC1035.", "location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, -"path": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}", +"path": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}", "response": { "$ref": "Operation" }, @@ -33463,14 +33845,14 @@ ] }, "get": { -"description": "Returns the specified TargetHttpsProxy resource in the specified region.", -"flatPath": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}", +"description": "Lists all of the ordered rules present in a single specified policy.", +"flatPath": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}", "httpMethod": "GET", -"id": "compute.regionTargetHttpsProxies.get", +"id": "compute.regionSslPolicies.get", "parameterOrder": [ "project", "region", -"targetHttpsProxy" +"sslPolicy" ], "parameters": { "project": { @@ -33487,17 +33869,16 @@ "required": true, "type": "string" }, -"targetHttpsProxy": { -"description": "Name of the TargetHttpsProxy resource to return.", +"sslPolicy": { +"description": "Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035.", "location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, -"path": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}", +"path": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}", "response": { -"$ref": "TargetHttpsProxy" +"$ref": "SslPolicy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -33506,10 +33887,10 @@ ] }, "insert": { -"description": "Creates a TargetHttpsProxy resource in the specified project and region using the data included in the request.", -"flatPath": "projects/{project}/regions/{region}/targetHttpsProxies", +"description": "Creates a new policy in the specified project and region using the data included in the request.", +"flatPath": "projects/{project}/regions/{region}/sslPolicies", "httpMethod": "POST", -"id": "compute.regionTargetHttpsProxies.insert", +"id": "compute.regionSslPolicies.insert", "parameterOrder": [ "project", "region" @@ -33535,9 +33916,9 @@ "type": "string" } }, -"path": "projects/{project}/regions/{region}/targetHttpsProxies", +"path": "projects/{project}/regions/{region}/sslPolicies", "request": { -"$ref": "TargetHttpsProxy" +"$ref": "SslPolicy" }, "response": { "$ref": "Operation" @@ -33548,10 +33929,10 @@ ] }, "list": { -"description": "Retrieves the list of TargetHttpsProxy resources available to the specified project in the specified region.", -"flatPath": "projects/{project}/regions/{region}/targetHttpsProxies", +"description": "Lists all the SSL policies that have been configured for the specified project and region.", +"flatPath": "projects/{project}/regions/{region}/sslPolicies", "httpMethod": "GET", -"id": "compute.regionTargetHttpsProxies.list", +"id": "compute.regionSslPolicies.list", "parameterOrder": [ "project", "region" @@ -33600,9 +33981,9 @@ "type": "boolean" } }, -"path": "projects/{project}/regions/{region}/targetHttpsProxies", +"path": "projects/{project}/regions/{region}/sslPolicies", "response": { -"$ref": "TargetHttpsProxyList" +"$ref": "SslPoliciesList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -33610,17 +33991,39 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, -"patch": { -"description": "Patches the specified regional TargetHttpsProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.", -"flatPath": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}", -"httpMethod": "PATCH", -"id": "compute.regionTargetHttpsProxies.patch", +"listAvailableFeatures": { +"description": "Lists all features that can be specified in the SSL policy when using custom profile.", +"flatPath": "projects/{project}/regions/{region}/sslPolicies/listAvailableFeatures", +"httpMethod": "GET", +"id": "compute.regionSslPolicies.listAvailableFeatures", "parameterOrder": [ "project", -"region", -"targetHttpsProxy" +"region" ], "parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", +"location": "query", +"type": "string" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", +"location": "query", +"type": "string" +}, "project": { "description": "Project ID for this request.", "location": "path", @@ -33629,46 +34032,37 @@ "type": "string" }, "region": { -"description": "Name of the region for this request.", +"description": "Name of the region scoping this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, -"requestId": { -"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", -"type": "string" -}, -"targetHttpsProxy": { -"description": "Name of the TargetHttpsProxy resource to patch.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", -"required": true, -"type": "string" +"type": "boolean" } }, -"path": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}", -"request": { -"$ref": "TargetHttpsProxy" -}, +"path": "projects/{project}/regions/{region}/sslPolicies/listAvailableFeatures", "response": { -"$ref": "Operation" +"$ref": "SslPoliciesListAvailableFeaturesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute" +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" ] }, -"setSslCertificates": { -"description": "Replaces SslCertificates for TargetHttpsProxy.", -"flatPath": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates", -"httpMethod": "POST", -"id": "compute.regionTargetHttpsProxies.setSslCertificates", +"patch": { +"description": "Patches the specified SSL policy with the data included in the request.", +"flatPath": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}", +"httpMethod": "PATCH", +"id": "compute.regionSslPolicies.patch", "parameterOrder": [ "project", "region", -"targetHttpsProxy" +"sslPolicy" ], "parameters": { "project": { @@ -33690,17 +34084,16 @@ "location": "query", "type": "string" }, -"targetHttpsProxy": { -"description": "Name of the TargetHttpsProxy resource to set an SslCertificates resource for.", +"sslPolicy": { +"description": "Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035.", "location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, -"path": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates", +"path": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}", "request": { -"$ref": "RegionTargetHttpsProxiesSetSslCertificatesRequest" +"$ref": "SslPolicy" }, "response": { "$ref": "Operation" @@ -33710,15 +34103,15 @@ "https://www.googleapis.com/auth/compute" ] }, -"setUrlMap": { -"description": "Changes the URL map for TargetHttpsProxy.", -"flatPath": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap", +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified resource.", +"flatPath": "projects/{project}/regions/{region}/sslPolicies/{resource}/testIamPermissions", "httpMethod": "POST", -"id": "compute.regionTargetHttpsProxies.setUrlMap", +"id": "compute.regionSslPolicies.testIamPermissions", "parameterOrder": [ "project", "region", -"targetHttpsProxy" +"resource" ], "parameters": { "project": { @@ -33729,71 +34122,21 @@ "type": "string" }, "region": { -"description": "Name of the region scoping this request.", +"description": "The name of the region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, -"requestId": { -"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", -"location": "query", -"type": "string" -}, -"targetHttpsProxy": { -"description": "Name of the TargetHttpsProxy to set a URL map for.", +"resource": { +"description": "Name or id of the resource for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, -"path": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap", -"request": { -"$ref": "UrlMapReference" -}, -"response": { -"$ref": "Operation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute" -] -}, -"testIamPermissions": { -"description": "Returns permissions that a caller has on the specified resource.", -"flatPath": "projects/{project}/regions/{region}/targetHttpsProxies/{resource}/testIamPermissions", -"httpMethod": "POST", -"id": "compute.regionTargetHttpsProxies.testIamPermissions", -"parameterOrder": [ -"project", -"region", -"resource" -], -"parameters": { -"project": { -"description": "Project ID for this request.", -"location": "path", -"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", -"required": true, -"type": "string" -}, -"region": { -"description": "The name of the region for this request.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", -"required": true, -"type": "string" -}, -"resource": { -"description": "Name or id of the resource for this request.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", -"required": true, -"type": "string" -} -}, -"path": "projects/{project}/regions/{region}/targetHttpsProxies/{resource}/testIamPermissions", +"path": "projects/{project}/regions/{region}/sslPolicies/{resource}/testIamPermissions", "request": { "$ref": "TestPermissionsRequest" }, @@ -33808,17 +34151,17 @@ } } }, -"regionTargetTcpProxies": { +"regionTargetHttpProxies": { "methods": { "delete": { -"description": "Deletes the specified TargetTcpProxy resource.", -"flatPath": "projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}", +"description": "Deletes the specified TargetHttpProxy resource.", +"flatPath": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}", "httpMethod": "DELETE", -"id": "compute.regionTargetTcpProxies.delete", +"id": "compute.regionTargetHttpProxies.delete", "parameterOrder": [ "project", "region", -"targetTcpProxy" +"targetHttpProxy" ], "parameters": { "project": { @@ -33840,15 +34183,15 @@ "location": "query", "type": "string" }, -"targetTcpProxy": { -"description": "Name of the TargetTcpProxy resource to delete.", +"targetHttpProxy": { +"description": "Name of the TargetHttpProxy resource to delete.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, -"path": "projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}", +"path": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}", "response": { "$ref": "Operation" }, @@ -33858,14 +34201,14 @@ ] }, "get": { -"description": "Returns the specified TargetTcpProxy resource.", -"flatPath": "projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}", +"description": "Returns the specified TargetHttpProxy resource in the specified region.", +"flatPath": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}", "httpMethod": "GET", -"id": "compute.regionTargetTcpProxies.get", +"id": "compute.regionTargetHttpProxies.get", "parameterOrder": [ "project", "region", -"targetTcpProxy" +"targetHttpProxy" ], "parameters": { "project": { @@ -33882,17 +34225,17 @@ "required": true, "type": "string" }, -"targetTcpProxy": { -"description": "Name of the TargetTcpProxy resource to return.", +"targetHttpProxy": { +"description": "Name of the TargetHttpProxy resource to return.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, -"path": "projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}", +"path": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}", "response": { -"$ref": "TargetTcpProxy" +"$ref": "TargetHttpProxy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -33901,10 +34244,10 @@ ] }, "insert": { -"description": "Creates a TargetTcpProxy resource in the specified project and region using the data included in the request.", -"flatPath": "projects/{project}/regions/{region}/targetTcpProxies", +"description": "Creates a TargetHttpProxy resource in the specified project and region using the data included in the request.", +"flatPath": "projects/{project}/regions/{region}/targetHttpProxies", "httpMethod": "POST", -"id": "compute.regionTargetTcpProxies.insert", +"id": "compute.regionTargetHttpProxies.insert", "parameterOrder": [ "project", "region" @@ -33930,9 +34273,9 @@ "type": "string" } }, -"path": "projects/{project}/regions/{region}/targetTcpProxies", +"path": "projects/{project}/regions/{region}/targetHttpProxies", "request": { -"$ref": "TargetTcpProxy" +"$ref": "TargetHttpProxy" }, "response": { "$ref": "Operation" @@ -33943,10 +34286,10 @@ ] }, "list": { -"description": "Retrieves a list of TargetTcpProxy resources available to the specified project in a given region.", -"flatPath": "projects/{project}/regions/{region}/targetTcpProxies", +"description": "Retrieves the list of TargetHttpProxy resources available to the specified project in the specified region.", +"flatPath": "projects/{project}/regions/{region}/targetHttpProxies", "httpMethod": "GET", -"id": "compute.regionTargetTcpProxies.list", +"id": "compute.regionTargetHttpProxies.list", "parameterOrder": [ "project", "region" @@ -33995,9 +34338,9 @@ "type": "boolean" } }, -"path": "projects/{project}/regions/{region}/targetTcpProxies", +"path": "projects/{project}/regions/{region}/targetHttpProxies", "response": { -"$ref": "TargetTcpProxyList" +"$ref": "TargetHttpProxyList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -34005,11 +34348,61 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, +"setUrlMap": { +"description": "Changes the URL map for TargetHttpProxy.", +"flatPath": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}/setUrlMap", +"httpMethod": "POST", +"id": "compute.regionTargetHttpProxies.setUrlMap", +"parameterOrder": [ +"project", +"region", +"targetHttpProxy" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region scoping this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"targetHttpProxy": { +"description": "Name of the TargetHttpProxy to set a URL map for.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}/setUrlMap", +"request": { +"$ref": "UrlMapReference" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, "testIamPermissions": { "description": "Returns permissions that a caller has on the specified resource.", -"flatPath": "projects/{project}/regions/{region}/targetTcpProxies/{resource}/testIamPermissions", +"flatPath": "projects/{project}/regions/{region}/targetHttpProxies/{resource}/testIamPermissions", "httpMethod": "POST", -"id": "compute.regionTargetTcpProxies.testIamPermissions", +"id": "compute.regionTargetHttpProxies.testIamPermissions", "parameterOrder": [ "project", "region", @@ -34038,7 +34431,7 @@ "type": "string" } }, -"path": "projects/{project}/regions/{region}/targetTcpProxies/{resource}/testIamPermissions", +"path": "projects/{project}/regions/{region}/targetHttpProxies/{resource}/testIamPermissions", "request": { "$ref": "TestPermissionsRequest" }, @@ -34053,17 +34446,17 @@ } } }, -"regionUrlMaps": { +"regionTargetHttpsProxies": { "methods": { "delete": { -"description": "Deletes the specified UrlMap resource.", -"flatPath": "projects/{project}/regions/{region}/urlMaps/{urlMap}", +"description": "Deletes the specified TargetHttpsProxy resource.", +"flatPath": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}", "httpMethod": "DELETE", -"id": "compute.regionUrlMaps.delete", +"id": "compute.regionTargetHttpsProxies.delete", "parameterOrder": [ "project", "region", -"urlMap" +"targetHttpsProxy" ], "parameters": { "project": { @@ -34081,19 +34474,19 @@ "type": "string" }, "requestId": { -"description": "begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.", +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, -"urlMap": { -"description": "Name of the UrlMap resource to delete.", +"targetHttpsProxy": { +"description": "Name of the TargetHttpsProxy resource to delete.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, -"path": "projects/{project}/regions/{region}/urlMaps/{urlMap}", +"path": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}", "response": { "$ref": "Operation" }, @@ -34103,14 +34496,14 @@ ] }, "get": { -"description": "Returns the specified UrlMap resource.", -"flatPath": "projects/{project}/regions/{region}/urlMaps/{urlMap}", +"description": "Returns the specified TargetHttpsProxy resource in the specified region.", +"flatPath": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}", "httpMethod": "GET", -"id": "compute.regionUrlMaps.get", +"id": "compute.regionTargetHttpsProxies.get", "parameterOrder": [ "project", "region", -"urlMap" +"targetHttpsProxy" ], "parameters": { "project": { @@ -34127,17 +34520,17 @@ "required": true, "type": "string" }, -"urlMap": { -"description": "Name of the UrlMap resource to return.", +"targetHttpsProxy": { +"description": "Name of the TargetHttpsProxy resource to return.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, -"path": "projects/{project}/regions/{region}/urlMaps/{urlMap}", +"path": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}", "response": { -"$ref": "UrlMap" +"$ref": "TargetHttpsProxy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -34146,10 +34539,10 @@ ] }, "insert": { -"description": "Creates a UrlMap resource in the specified project using the data included in the request.", -"flatPath": "projects/{project}/regions/{region}/urlMaps", +"description": "Creates a TargetHttpsProxy resource in the specified project and region using the data included in the request.", +"flatPath": "projects/{project}/regions/{region}/targetHttpsProxies", "httpMethod": "POST", -"id": "compute.regionUrlMaps.insert", +"id": "compute.regionTargetHttpsProxies.insert", "parameterOrder": [ "project", "region" @@ -34170,64 +34563,14 @@ "type": "string" }, "requestId": { -"description": "begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.", -"location": "query", -"type": "string" -} -}, -"path": "projects/{project}/regions/{region}/urlMaps", -"request": { -"$ref": "UrlMap" -}, -"response": { -"$ref": "Operation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute" -] -}, -"invalidateCache": { -"description": "Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. For more information, see [Invalidating cached content](/cdn/docs/invalidating-cached-content).", -"flatPath": "projects/{project}/regions/{region}/urlMaps/{urlMap}/invalidateCache", -"httpMethod": "POST", -"id": "compute.regionUrlMaps.invalidateCache", -"parameterOrder": [ -"project", -"region", -"urlMap" -], -"parameters": { -"project": { -"description": "Project ID for this request.", -"location": "path", -"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", -"required": true, -"type": "string" -}, -"region": { -"description": "Name of the region scoping this request.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", -"required": true, -"type": "string" -}, -"requestId": { -"description": "begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.", +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" -}, -"urlMap": { -"description": "Name of the UrlMap scoping this request.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", -"required": true, -"type": "string" } }, -"path": "projects/{project}/regions/{region}/urlMaps/{urlMap}/invalidateCache", +"path": "projects/{project}/regions/{region}/targetHttpsProxies", "request": { -"$ref": "CacheInvalidationRule" +"$ref": "TargetHttpsProxy" }, "response": { "$ref": "Operation" @@ -34238,10 +34581,10 @@ ] }, "list": { -"description": "Retrieves the list of UrlMap resources available to the specified project in the specified region.", -"flatPath": "projects/{project}/regions/{region}/urlMaps", +"description": "Retrieves the list of TargetHttpsProxy resources available to the specified project in the specified region.", +"flatPath": "projects/{project}/regions/{region}/targetHttpsProxies", "httpMethod": "GET", -"id": "compute.regionUrlMaps.list", +"id": "compute.regionTargetHttpsProxies.list", "parameterOrder": [ "project", "region" @@ -34290,9 +34633,9 @@ "type": "boolean" } }, -"path": "projects/{project}/regions/{region}/urlMaps", +"path": "projects/{project}/regions/{region}/targetHttpsProxies", "response": { -"$ref": "UrlMapList" +"$ref": "TargetHttpsProxyList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -34301,14 +34644,14 @@ ] }, "patch": { -"description": "Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.", -"flatPath": "projects/{project}/regions/{region}/urlMaps/{urlMap}", +"description": "Patches the specified regional TargetHttpsProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.", +"flatPath": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}", "httpMethod": "PATCH", -"id": "compute.regionUrlMaps.patch", +"id": "compute.regionTargetHttpsProxies.patch", "parameterOrder": [ "project", "region", -"urlMap" +"targetHttpsProxy" ], "parameters": { "project": { @@ -34319,28 +34662,28 @@ "type": "string" }, "region": { -"description": "Name of the region scoping this request.", +"description": "Name of the region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, "requestId": { -"description": "begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.", +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, -"urlMap": { -"description": "Name of the UrlMap resource to patch.", +"targetHttpsProxy": { +"description": "Name of the TargetHttpsProxy resource to patch.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, -"path": "projects/{project}/regions/{region}/urlMaps/{urlMap}", +"path": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}", "request": { -"$ref": "UrlMap" +"$ref": "TargetHttpsProxy" }, "response": { "$ref": "Operation" @@ -34350,15 +34693,15 @@ "https://www.googleapis.com/auth/compute" ] }, -"testIamPermissions": { -"description": "Returns permissions that a caller has on the specified resource.", -"flatPath": "projects/{project}/regions/{region}/urlMaps/{resource}/testIamPermissions", +"setSslCertificates": { +"description": "Replaces SslCertificates for TargetHttpsProxy.", +"flatPath": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates", "httpMethod": "POST", -"id": "compute.regionUrlMaps.testIamPermissions", +"id": "compute.regionTargetHttpsProxies.setSslCertificates", "parameterOrder": [ "project", "region", -"resource" +"targetHttpsProxy" ], "parameters": { "project": { @@ -34369,42 +34712,46 @@ "type": "string" }, "region": { -"description": "The name of the region for this request.", +"description": "Name of the region scoping this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, -"resource": { -"description": "Name or id of the resource for this request.", +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"targetHttpsProxy": { +"description": "Name of the TargetHttpsProxy resource to set an SslCertificates resource for.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, -"path": "projects/{project}/regions/{region}/urlMaps/{resource}/testIamPermissions", +"path": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates", "request": { -"$ref": "TestPermissionsRequest" +"$ref": "RegionTargetHttpsProxiesSetSslCertificatesRequest" }, "response": { -"$ref": "TestPermissionsResponse" +"$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] }, -"update": { -"description": "Updates the specified UrlMap resource with the data included in the request.", -"flatPath": "projects/{project}/regions/{region}/urlMaps/{urlMap}", -"httpMethod": "PUT", -"id": "compute.regionUrlMaps.update", +"setUrlMap": { +"description": "Changes the URL map for TargetHttpsProxy.", +"flatPath": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap", +"httpMethod": "POST", +"id": "compute.regionTargetHttpsProxies.setUrlMap", "parameterOrder": [ "project", "region", -"urlMap" +"targetHttpsProxy" ], "parameters": { "project": { @@ -34422,21 +34769,21 @@ "type": "string" }, "requestId": { -"description": "begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.", +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, -"urlMap": { -"description": "Name of the UrlMap resource to update.", +"targetHttpsProxy": { +"description": "Name of the TargetHttpsProxy to set a URL map for.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, -"path": "projects/{project}/regions/{region}/urlMaps/{urlMap}", +"path": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap", "request": { -"$ref": "UrlMap" +"$ref": "UrlMapReference" }, "response": { "$ref": "Operation" @@ -34446,15 +34793,15 @@ "https://www.googleapis.com/auth/compute" ] }, -"validate": { -"description": "Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.", -"flatPath": "projects/{project}/regions/{region}/urlMaps/{urlMap}/validate", +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified resource.", +"flatPath": "projects/{project}/regions/{region}/targetHttpsProxies/{resource}/testIamPermissions", "httpMethod": "POST", -"id": "compute.regionUrlMaps.validate", +"id": "compute.regionTargetHttpsProxies.testIamPermissions", "parameterOrder": [ "project", "region", -"urlMap" +"resource" ], "parameters": { "project": { @@ -34465,69 +34812,95 @@ "type": "string" }, "region": { -"description": "Name of the region scoping this request.", +"description": "The name of the region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, -"urlMap": { -"description": "Name of the UrlMap resource to be validated as.", +"resource": { +"description": "Name or id of the resource for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, -"path": "projects/{project}/regions/{region}/urlMaps/{urlMap}/validate", +"path": "projects/{project}/regions/{region}/targetHttpsProxies/{resource}/testIamPermissions", "request": { -"$ref": "RegionUrlMapsValidateRequest" +"$ref": "TestPermissionsRequest" }, "response": { -"$ref": "UrlMapsValidateResponse" +"$ref": "TestPermissionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute" +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" ] } } }, -"regionZones": { +"regionTargetTcpProxies": { "methods": { -"list": { -"description": "Retrieves the list of Zone resources under the specific region available to the specified project.", -"flatPath": "projects/{project}/regions/{region}/zones", -"httpMethod": "GET", -"id": "compute.regionZones.list", +"delete": { +"description": "Deletes the specified TargetTcpProxy resource.", +"flatPath": "projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}", +"httpMethod": "DELETE", +"id": "compute.regionTargetTcpProxies.delete", "parameterOrder": [ "project", -"region" +"region", +"targetTcpProxy" ], "parameters": { -"filter": { -"description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", -"location": "query", +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, "type": "string" }, -"maxResults": { -"default": "500", -"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", -"format": "uint32", -"location": "query", -"minimum": "0", -"type": "integer" +"region": { +"description": "Name of the region scoping this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" }, -"orderBy": { -"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, -"pageToken": { -"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", -"location": "query", +"targetTcpProxy": { +"description": "Name of the TargetTcpProxy resource to delete.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, "type": "string" +} +}, +"path": "projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] }, +"get": { +"description": "Returns the specified TargetTcpProxy resource.", +"flatPath": "projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}", +"httpMethod": "GET", +"id": "compute.regionTargetTcpProxies.get", +"parameterOrder": [ +"project", +"region", +"targetTcpProxy" +], +"parameters": { "project": { "description": "Project ID for this request.", "location": "path", @@ -34536,37 +34909,35 @@ "type": "string" }, "region": { -"description": "Region for this request.", +"description": "Name of the region scoping this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, -"returnPartialSuccess": { -"description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", -"location": "query", -"type": "boolean" +"targetTcpProxy": { +"description": "Name of the TargetTcpProxy resource to return.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" } }, -"path": "projects/{project}/regions/{region}/zones", +"path": "projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}", "response": { -"$ref": "ZoneList" +"$ref": "TargetTcpProxy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ] -} -} }, -"regions": { -"methods": { -"get": { -"description": "Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (the `items.quotas` field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method.", -"flatPath": "projects/{project}/regions/{region}", -"httpMethod": "GET", -"id": "compute.regions.get", +"insert": { +"description": "Creates a TargetTcpProxy resource in the specified project and region using the data included in the request.", +"flatPath": "projects/{project}/regions/{region}/targetTcpProxies", +"httpMethod": "POST", +"id": "compute.regionTargetTcpProxies.insert", "parameterOrder": [ "project", "region" @@ -34580,30 +34951,38 @@ "type": "string" }, "region": { -"description": "Name of the region resource to return.", +"description": "Name of the region scoping this request.", "location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" } }, -"path": "projects/{project}/regions/{region}", +"path": "projects/{project}/regions/{region}/targetTcpProxies", +"request": { +"$ref": "TargetTcpProxy" +}, "response": { -"$ref": "Region" +"$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] }, "list": { -"description": "Retrieves the list of region resources available to the specified project. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `items.quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (the `items.quotas` field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method.", -"flatPath": "projects/{project}/regions", +"description": "Retrieves a list of TargetTcpProxy resources available to the specified project in a given region.", +"flatPath": "projects/{project}/regions/{region}/targetTcpProxies", "httpMethod": "GET", -"id": "compute.regions.list", +"id": "compute.regionTargetTcpProxies.list", "parameterOrder": [ -"project" +"project", +"region" ], "parameters": { "filter": { @@ -34636,202 +35015,118 @@ "required": true, "type": "string" }, +"region": { +"description": "Name of the region scoping this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, -"path": "projects/{project}/regions", +"path": "projects/{project}/regions/{region}/targetTcpProxies", "response": { -"$ref": "RegionList" +"$ref": "TargetTcpProxyList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ] -} -} }, -"reservationBlocks": { -"methods": { -"get": { -"description": "Retrieves information about the specified reservation block.", -"flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservationBlock}", -"httpMethod": "GET", -"id": "compute.reservationBlocks.get", +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified resource.", +"flatPath": "projects/{project}/regions/{region}/targetTcpProxies/{resource}/testIamPermissions", +"httpMethod": "POST", +"id": "compute.regionTargetTcpProxies.testIamPermissions", "parameterOrder": [ "project", -"zone", -"reservation", -"reservationBlock" +"region", +"resource" ], "parameters": { "project": { "description": "Project ID for this request.", "location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "required": true, "type": "string" }, -"reservation": { -"description": "The name of the reservation. Name should conform to RFC1035 or be a resource ID.", -"location": "path", -"required": true, -"type": "string" -}, -"reservationBlock": { -"description": "The name of the reservation block. Name should conform to RFC1035 or be a resource ID.", +"region": { +"description": "The name of the region for this request.", "location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, -"view": { -"description": "View of the Block.", -"enum": [ -"BASIC", -"BLOCK_VIEW_UNSPECIFIED", -"FULL" -], -"enumDescriptions": [ -"This view includes basic information about the reservation block", -"The default / unset value. The API will default to the BASIC view.", -"Includes detailed topology view." -], -"location": "query", -"type": "string" -}, -"zone": { -"description": "Name of the zone for this request. Zone name should conform to RFC1035.", +"resource": { +"description": "Name or id of the resource for this request.", "location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, -"path": "projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservationBlock}", +"path": "projects/{project}/regions/{region}/targetTcpProxies/{resource}/testIamPermissions", +"request": { +"$ref": "TestPermissionsRequest" +}, "response": { -"$ref": "ReservationBlocksGetResponse" +"$ref": "TestPermissionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ] +} +} }, -"list": { -"description": "Retrieves a list of reservation blocks under a single reservation.", -"flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks", -"httpMethod": "GET", -"id": "compute.reservationBlocks.list", +"regionUrlMaps": { +"methods": { +"delete": { +"description": "Deletes the specified UrlMap resource.", +"flatPath": "projects/{project}/regions/{region}/urlMaps/{urlMap}", +"httpMethod": "DELETE", +"id": "compute.regionUrlMaps.delete", "parameterOrder": [ "project", -"zone", -"reservation" +"region", +"urlMap" ], "parameters": { -"filter": { -"description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", -"location": "query", -"type": "string" -}, -"maxResults": { -"default": "500", -"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", -"format": "uint32", -"location": "query", -"minimum": "0", -"type": "integer" -}, -"orderBy": { -"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", -"location": "query", -"type": "string" -}, -"pageToken": { -"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", -"location": "query", -"type": "string" -}, "project": { "description": "Project ID for this request.", "location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "required": true, "type": "string" }, -"reservation": { -"description": "The name of the reservation. Name should conform to RFC1035 or be a resource ID.", -"location": "path", -"required": true, -"type": "string" -}, -"returnPartialSuccess": { -"description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", -"location": "query", -"type": "boolean" -}, -"zone": { -"description": "Name of the zone for this request. Zone name should conform to RFC1035.", -"location": "path", -"required": true, -"type": "string" -} -}, -"path": "projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks", -"response": { -"$ref": "ReservationBlocksListResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" -] -}, -"performMaintenance": { -"description": "Allows customers to perform maintenance on a reservation block", -"flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservationBlock}/performMaintenance", -"httpMethod": "POST", -"id": "compute.reservationBlocks.performMaintenance", -"parameterOrder": [ -"project", -"zone", -"reservation", -"reservationBlock" -], -"parameters": { -"project": { -"description": "Project ID for this request.", +"region": { +"description": "Name of the region scoping this request.", "location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, "requestId": { -"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"description": "begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.", "location": "query", "type": "string" }, -"reservation": { -"description": "The name of the reservation. Name should conform to RFC1035 or be a resource ID.", -"location": "path", -"required": true, -"type": "string" -}, -"reservationBlock": { -"description": "The name of the reservation block. Name should conform to RFC1035 or be a resource ID.", -"location": "path", -"required": true, -"type": "string" -}, -"zone": { -"description": "Name of the zone for this request. Zone name should conform to RFC1035.", +"urlMap": { +"description": "Name of the UrlMap resource to delete.", "location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, -"path": "projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservationBlock}/performMaintenance", -"request": { -"$ref": "ReservationsBlocksPerformMaintenanceRequest" -}, +"path": "projects/{project}/regions/{region}/urlMaps/{urlMap}", "response": { "$ref": "Operation" }, @@ -34839,51 +35134,43 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] -} -} }, -"reservationSubBlocks": { -"methods": { "get": { -"description": "Retrieves information about the specified reservation subBlock.", -"flatPath": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}", +"description": "Returns the specified UrlMap resource.", +"flatPath": "projects/{project}/regions/{region}/urlMaps/{urlMap}", "httpMethod": "GET", -"id": "compute.reservationSubBlocks.get", +"id": "compute.regionUrlMaps.get", "parameterOrder": [ "project", -"zone", -"parentName", -"reservationSubBlock" +"region", +"urlMap" ], "parameters": { -"parentName": { -"description": "The name of the parent reservation and parent block. In the format of reservations/{reservation_name}/reservationBlocks/{reservation_block_name}", -"location": "path", -"required": true, -"type": "string" -}, "project": { "description": "Project ID for this request.", "location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "required": true, "type": "string" }, -"reservationSubBlock": { -"description": "The name of the reservation subBlock. Name should conform to RFC1035 or be a resource ID.", +"region": { +"description": "Name of the region scoping this request.", "location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, -"zone": { -"description": "Name of the zone for this request. Zone name should conform to RFC1035.", +"urlMap": { +"description": "Name of the UrlMap resource to return.", "location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, -"path": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}", +"path": "projects/{project}/regions/{region}/urlMaps/{urlMap}", "response": { -"$ref": "ReservationSubBlocksGetResponse" +"$ref": "UrlMap" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -34891,117 +35178,90 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, -"list": { -"description": "Retrieves a list of reservation subBlocks under a single reservation.", -"flatPath": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks", -"httpMethod": "GET", -"id": "compute.reservationSubBlocks.list", +"insert": { +"description": "Creates a UrlMap resource in the specified project using the data included in the request.", +"flatPath": "projects/{project}/regions/{region}/urlMaps", +"httpMethod": "POST", +"id": "compute.regionUrlMaps.insert", "parameterOrder": [ "project", -"zone", -"parentName" +"region" ], "parameters": { -"filter": { -"description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", -"location": "query", -"type": "string" -}, -"maxResults": { -"default": "500", -"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", -"format": "uint32", -"location": "query", -"minimum": "0", -"type": "integer" -}, -"orderBy": { -"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", -"location": "query", -"type": "string" -}, -"pageToken": { -"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", -"location": "query", -"type": "string" -}, -"parentName": { -"description": "The name of the parent reservation and parent block. In the format of reservations/{reservation_name}/reservationBlocks/{reservation_block_name}", +"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" }, -"project": { -"description": "Project ID for this request.", +"region": { +"description": "Name of the region scoping this request.", "location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, -"returnPartialSuccess": { -"description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", +"requestId": { +"description": "begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.", "location": "query", -"type": "boolean" -}, -"zone": { -"description": "Name of the zone for this request. Zone name should conform to RFC1035.", -"location": "path", -"required": true, "type": "string" } }, -"path": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks", +"path": "projects/{project}/regions/{region}/urlMaps", +"request": { +"$ref": "UrlMap" +}, "response": { -"$ref": "ReservationSubBlocksListResponse" +"$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] }, -"performMaintenance": { -"description": "Allows customers to perform maintenance on a reservation subBlock", -"flatPath": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/performMaintenance", +"invalidateCache": { +"description": "Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. For more information, see [Invalidating cached content](/cdn/docs/invalidating-cached-content).", +"flatPath": "projects/{project}/regions/{region}/urlMaps/{urlMap}/invalidateCache", "httpMethod": "POST", -"id": "compute.reservationSubBlocks.performMaintenance", +"id": "compute.regionUrlMaps.invalidateCache", "parameterOrder": [ "project", -"zone", -"parentName", -"reservationSubBlock" +"region", +"urlMap" ], "parameters": { -"parentName": { -"description": "The name of the parent reservation and parent block. In the format of reservations/{reservation_name}/reservationBlocks/{reservation_block_name}", +"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" }, -"project": { -"description": "Project ID for this request.", +"region": { +"description": "Name of the region scoping this request.", "location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, "requestId": { -"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"description": "begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.", "location": "query", "type": "string" }, -"reservationSubBlock": { -"description": "The name of the reservation subBlock. Name should conform to RFC1035 or be a resource ID.", -"location": "path", -"required": true, -"type": "string" -}, -"zone": { -"description": "Name of the zone for this request. Zone name should conform to RFC1035.", +"urlMap": { +"description": "Name of the UrlMap scoping this request.", "location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, -"path": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/performMaintenance", +"path": "projects/{project}/regions/{region}/urlMaps/{urlMap}/invalidateCache", +"request": { +"$ref": "CacheInvalidationRule" +}, "response": { "$ref": "Operation" }, @@ -35009,18 +35269,15 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] -} -} }, -"reservations": { -"methods": { -"aggregatedList": { -"description": "Retrieves an aggregated list of reservations. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", -"flatPath": "projects/{project}/aggregated/reservations", +"list": { +"description": "Retrieves the list of UrlMap resources available to the specified project in the specified region.", +"flatPath": "projects/{project}/regions/{region}/urlMaps", "httpMethod": "GET", -"id": "compute.reservations.aggregatedList", +"id": "compute.regionUrlMaps.list", "parameterOrder": [ -"project" +"project", +"region" ], "parameters": { "filter": { @@ -35028,11 +35285,6 @@ "location": "query", "type": "string" }, -"includeAllScopes": { -"description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", -"location": "query", -"type": "boolean" -}, "maxResults": { "default": "500", "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", @@ -35058,21 +35310,22 @@ "required": true, "type": "string" }, +"region": { +"description": "Name of the region scoping this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" -}, -"serviceProjectNumber": { -"description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", -"format": "int64", -"location": "query", -"type": "string" } }, -"path": "projects/{project}/aggregated/reservations", +"path": "projects/{project}/regions/{region}/urlMaps", "response": { -"$ref": "ReservationAggregatedList" +"$ref": "UrlMapList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -35080,15 +35333,15 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, -"delete": { -"description": "Deletes the specified reservation.", -"flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}", -"httpMethod": "DELETE", -"id": "compute.reservations.delete", +"patch": { +"description": "Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.", +"flatPath": "projects/{project}/regions/{region}/urlMaps/{urlMap}", +"httpMethod": "PATCH", +"id": "compute.regionUrlMaps.patch", "parameterOrder": [ "project", -"zone", -"reservation" +"region", +"urlMap" ], "parameters": { "project": { @@ -35098,27 +35351,30 @@ "required": true, "type": "string" }, +"region": { +"description": "Name of the region scoping this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, "requestId": { -"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"description": "begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.", "location": "query", "type": "string" }, -"reservation": { -"description": "Name of the reservation to delete.", +"urlMap": { +"description": "Name of the UrlMap resource to patch.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" -}, -"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}/reservations/{reservation}", +"path": "projects/{project}/regions/{region}/urlMaps/{urlMap}", +"request": { +"$ref": "UrlMap" +}, "response": { "$ref": "Operation" }, @@ -35127,15 +35383,15 @@ "https://www.googleapis.com/auth/compute" ] }, -"get": { -"description": "Retrieves information about the specified reservation.", -"flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}", -"httpMethod": "GET", -"id": "compute.reservations.get", +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified resource.", +"flatPath": "projects/{project}/regions/{region}/urlMaps/{resource}/testIamPermissions", +"httpMethod": "POST", +"id": "compute.regionUrlMaps.testIamPermissions", "parameterOrder": [ "project", -"zone", -"reservation" +"region", +"resource" ], "parameters": { "project": { @@ -35145,24 +35401,27 @@ "required": true, "type": "string" }, -"reservation": { -"description": "Name of the reservation to retrieve.", +"region": { +"description": "The name of the region for this request.", "location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, -"zone": { -"description": "Name of the zone for this request.", +"resource": { +"description": "Name or id of the resource for this request.", "location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, -"path": "projects/{project}/zones/{zone}/reservations/{reservation}", +"path": "projects/{project}/regions/{region}/urlMaps/{resource}/testIamPermissions", +"request": { +"$ref": "TestPermissionsRequest" +}, "response": { -"$ref": "Reservation" +"$ref": "TestPermissionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -35170,23 +35429,17 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, -"getIamPolicy": { -"description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.", -"flatPath": "projects/{project}/zones/{zone}/reservations/{resource}/getIamPolicy", -"httpMethod": "GET", -"id": "compute.reservations.getIamPolicy", +"update": { +"description": "Updates the specified UrlMap resource with the data included in the request.", +"flatPath": "projects/{project}/regions/{region}/urlMaps/{urlMap}", +"httpMethod": "PUT", +"id": "compute.regionUrlMaps.update", "parameterOrder": [ "project", -"zone", -"resource" +"region", +"urlMap" ], "parameters": { -"optionsRequestedPolicyVersion": { -"description": "Requested IAM Policy version.", -"format": "int32", -"location": "query", -"type": "integer" -}, "project": { "description": "Project ID for this request.", "location": "path", @@ -35194,39 +35447,47 @@ "required": true, "type": "string" }, -"resource": { -"description": "Name or id of the resource for this request.", +"region": { +"description": "Name of the region scoping this request.", "location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, -"zone": { -"description": "The name of the zone for this request.", +"requestId": { +"description": "begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.", +"location": "query", +"type": "string" +}, +"urlMap": { +"description": "Name of the UrlMap resource to update.", "location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, -"path": "projects/{project}/zones/{zone}/reservations/{resource}/getIamPolicy", +"path": "projects/{project}/regions/{region}/urlMaps/{urlMap}", +"request": { +"$ref": "UrlMap" +}, "response": { -"$ref": "Policy" +"$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] }, -"insert": { -"description": "Creates a new reservation. For more information, read Reserving zonal resources.", -"flatPath": "projects/{project}/zones/{zone}/reservations", +"validate": { +"description": "Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.", +"flatPath": "projects/{project}/regions/{region}/urlMaps/{urlMap}/validate", "httpMethod": "POST", -"id": "compute.reservations.insert", +"id": "compute.regionUrlMaps.validate", "parameterOrder": [ "project", -"zone" +"region", +"urlMap" ], "parameters": { "project": { @@ -35236,39 +35497,45 @@ "required": true, "type": "string" }, -"requestId": { -"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", -"location": "query", +"region": { +"description": "Name of the region scoping this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, "type": "string" }, -"zone": { -"description": "Name of the zone for this request.", +"urlMap": { +"description": "Name of the UrlMap resource to be validated as.", "location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, -"path": "projects/{project}/zones/{zone}/reservations", +"path": "projects/{project}/regions/{region}/urlMaps/{urlMap}/validate", "request": { -"$ref": "Reservation" +"$ref": "RegionUrlMapsValidateRequest" }, "response": { -"$ref": "Operation" +"$ref": "UrlMapsValidateResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] +} +} }, +"regionZones": { +"methods": { "list": { -"description": "A list of all the reservations that have been configured for the specified project in specified zone.", -"flatPath": "projects/{project}/zones/{zone}/reservations", +"description": "Retrieves the list of Zone resources under the specific region available to the specified project.", +"flatPath": "projects/{project}/regions/{region}/zones", "httpMethod": "GET", -"id": "compute.reservations.list", +"id": "compute.regionZones.list", "parameterOrder": [ "project", -"zone" +"region" ], "parameters": { "filter": { @@ -35301,58 +35568,172 @@ "required": true, "type": "string" }, -"returnPartialSuccess": { -"description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", -"location": "query", -"type": "boolean" -}, -"zone": { -"description": "Name of the zone for this request.", +"region": { +"description": "Region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", +"location": "query", +"type": "boolean" } }, -"path": "projects/{project}/zones/{zone}/reservations", +"path": "projects/{project}/regions/{region}/zones", "response": { -"$ref": "ReservationList" +"$ref": "ZoneList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ] +} +} }, -"performMaintenance": { -"description": "Perform maintenance on an extended reservation", -"flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}/performMaintenance", -"httpMethod": "POST", -"id": "compute.reservations.performMaintenance", +"regions": { +"methods": { +"get": { +"description": "Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (the `items.quotas` field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method.", +"flatPath": "projects/{project}/regions/{region}", +"httpMethod": "GET", +"id": "compute.regions.get", "parameterOrder": [ "project", -"zone", -"reservation" +"region" ], "parameters": { "project": { "description": "Project ID for this request.", "location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "required": true, "type": "string" }, -"requestId": { -"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"region": { +"description": "Name of the region resource to return.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}", +"response": { +"$ref": "Region" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"list": { +"description": "Retrieves the list of region resources available to the specified project. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `items.quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (the `items.quotas` field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method.", +"flatPath": "projects/{project}/regions", +"httpMethod": "GET", +"id": "compute.regions.list", +"parameterOrder": [ +"project" +], +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", +"location": "query", +"type": "string" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", +"location": "query", +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", +"type": "boolean" +} +}, +"path": "projects/{project}/regions", +"response": { +"$ref": "RegionList" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +} +} +}, +"reservationBlocks": { +"methods": { +"get": { +"description": "Retrieves information about the specified reservation block.", +"flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservationBlock}", +"httpMethod": "GET", +"id": "compute.reservationBlocks.get", +"parameterOrder": [ +"project", +"zone", +"reservation", +"reservationBlock" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"required": true, "type": "string" }, "reservation": { "description": "The name of the reservation. Name should conform to RFC1035 or be a resource ID.", "location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" }, +"reservationBlock": { +"description": "The name of the reservation block. Name should conform to RFC1035 or be a resource ID.", +"location": "path", +"required": true, +"type": "string" +}, +"view": { +"description": "View of the Block.", +"enum": [ +"BASIC", +"BLOCK_VIEW_UNSPECIFIED", +"FULL" +], +"enumDescriptions": [ +"This view includes basic information about the reservation block", +"The default / unset value. The API will default to the BASIC view.", +"Includes detailed topology view." +], +"location": "query", +"type": "string" +}, "zone": { "description": "Name of the zone for this request. Zone name should conform to RFC1035.", "location": "path", @@ -35360,33 +35741,99 @@ "type": "string" } }, -"path": "projects/{project}/zones/{zone}/reservations/{reservation}/performMaintenance", -"request": { -"$ref": "ReservationsPerformMaintenanceRequest" +"path": "projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservationBlock}", +"response": { +"$ref": "ReservationBlocksGetResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"list": { +"description": "Retrieves a list of reservation blocks under a single reservation.", +"flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks", +"httpMethod": "GET", +"id": "compute.reservationBlocks.list", +"parameterOrder": [ +"project", +"zone", +"reservation" +], +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", +"location": "query", +"type": "string" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", +"location": "query", +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"required": true, +"type": "string" +}, +"reservation": { +"description": "The name of the reservation. Name should conform to RFC1035 or be a resource ID.", +"location": "path", +"required": true, +"type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", +"location": "query", +"type": "boolean" +}, +"zone": { +"description": "Name of the zone for this request. Zone name should conform to RFC1035.", +"location": "path", +"required": true, +"type": "string" +} }, +"path": "projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks", "response": { -"$ref": "Operation" +"$ref": "ReservationBlocksListResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute" +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" ] }, -"resize": { -"description": "Resizes the reservation (applicable to standalone reservations only). For more information, read Modifying reservations.", -"flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}/resize", +"performMaintenance": { +"description": "Allows customers to perform maintenance on a reservation block", +"flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservationBlock}/performMaintenance", "httpMethod": "POST", -"id": "compute.reservations.resize", +"id": "compute.reservationBlocks.performMaintenance", "parameterOrder": [ "project", "zone", -"reservation" +"reservation", +"reservationBlock" ], "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" }, @@ -35396,23 +35843,27 @@ "type": "string" }, "reservation": { -"description": "Name of the reservation to update.", +"description": "The name of the reservation. Name should conform to RFC1035 or be a resource ID.", +"location": "path", +"required": true, +"type": "string" +}, +"reservationBlock": { +"description": "The name of the reservation block. Name should conform to RFC1035 or be a resource ID.", "location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, "zone": { -"description": "Name of the zone for this request.", +"description": "Name of the zone for this request. Zone name should conform to RFC1035.", "location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" } }, -"path": "projects/{project}/zones/{zone}/reservations/{reservation}/resize", +"path": "projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservationBlock}/performMaintenance", "request": { -"$ref": "ReservationsResizeRequest" +"$ref": "ReservationsBlocksPerformMaintenanceRequest" }, "response": { "$ref": "Operation" @@ -35421,91 +35872,119 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] +} +} }, -"setIamPolicy": { -"description": "Sets the access control policy on the specified resource. Replaces any existing policy.", -"flatPath": "projects/{project}/zones/{zone}/reservations/{resource}/setIamPolicy", -"httpMethod": "POST", -"id": "compute.reservations.setIamPolicy", +"reservationSubBlocks": { +"methods": { +"get": { +"description": "Retrieves information about the specified reservation subBlock.", +"flatPath": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}", +"httpMethod": "GET", +"id": "compute.reservationSubBlocks.get", "parameterOrder": [ "project", "zone", -"resource" +"parentName", +"reservationSubBlock" ], "parameters": { +"parentName": { +"description": "The name of the parent reservation and parent block. In the format of reservations/{reservation_name}/reservationBlocks/{reservation_block_name}", +"location": "path", +"required": true, +"type": "string" +}, "project": { "description": "Project ID for this request.", "location": "path", -"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "required": true, "type": "string" }, -"resource": { -"description": "Name or id of the resource for this request.", +"reservationSubBlock": { +"description": "The name of the reservation subBlock. Name should conform to RFC1035 or be a resource ID.", "location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" }, "zone": { -"description": "The name of the zone for this request.", +"description": "Name of the zone for this request. Zone name should conform to RFC1035.", "location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" } }, -"path": "projects/{project}/zones/{zone}/reservations/{resource}/setIamPolicy", -"request": { -"$ref": "ZoneSetPolicyRequest" -}, +"path": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}", "response": { -"$ref": "Policy" +"$ref": "ReservationSubBlocksGetResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute" +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" ] }, -"testIamPermissions": { -"description": "Returns permissions that a caller has on the specified resource.", -"flatPath": "projects/{project}/zones/{zone}/reservations/{resource}/testIamPermissions", -"httpMethod": "POST", -"id": "compute.reservations.testIamPermissions", +"list": { +"description": "Retrieves a list of reservation subBlocks under a single reservation.", +"flatPath": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks", +"httpMethod": "GET", +"id": "compute.reservationSubBlocks.list", "parameterOrder": [ "project", "zone", -"resource" +"parentName" ], "parameters": { -"project": { -"description": "Project ID for this request.", +"filter": { +"description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", +"location": "query", +"type": "string" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", +"location": "query", +"type": "string" +}, +"parentName": { +"description": "The name of the parent reservation and parent block. In the format of reservations/{reservation_name}/reservationBlocks/{reservation_block_name}", "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.", +"project": { +"description": "Project ID for this request.", "location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" }, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", +"location": "query", +"type": "boolean" +}, "zone": { -"description": "The name of the zone for this request.", +"description": "Name of the zone for this request. Zone name should conform to RFC1035.", "location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" } }, -"path": "projects/{project}/zones/{zone}/reservations/{resource}/testIamPermissions", -"request": { -"$ref": "TestPermissionsRequest" -}, +"path": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks", "response": { -"$ref": "TestPermissionsResponse" +"$ref": "ReservationSubBlocksListResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -35513,26 +35992,27 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, -"update": { -"description": "Update share settings of the reservation.", -"flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}", -"httpMethod": "PATCH", -"id": "compute.reservations.update", +"performMaintenance": { +"description": "Allows customers to perform maintenance on a reservation subBlock", +"flatPath": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/performMaintenance", +"httpMethod": "POST", +"id": "compute.reservationSubBlocks.performMaintenance", "parameterOrder": [ "project", "zone", -"reservation" +"parentName", +"reservationSubBlock" ], "parameters": { -"paths": { -"location": "query", -"repeated": true, +"parentName": { +"description": "The name of the parent reservation and parent block. In the format of reservations/{reservation_name}/reservationBlocks/{reservation_block_name}", +"location": "path", +"required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "location": "path", -"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "required": true, "type": "string" }, @@ -35541,30 +36021,73 @@ "location": "query", "type": "string" }, -"reservation": { -"description": "Name of the reservation to update.", +"reservationSubBlock": { +"description": "The name of the reservation subBlock. Name should conform to RFC1035 or be a resource ID.", "location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" }, -"updateMask": { -"description": "Update_mask indicates fields to be updated as part of this request.", -"format": "google-fieldmask", +"zone": { +"description": "Name of the zone for this request. Zone name should conform to RFC1035.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/performMaintenance", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"reportFaulty": { +"description": "Allows customers to report a faulty subBlock.", +"flatPath": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/reportFaulty", +"httpMethod": "POST", +"id": "compute.reservationSubBlocks.reportFaulty", +"parameterOrder": [ +"project", +"zone", +"parentName", +"reservationSubBlock" +], +"parameters": { +"parentName": { +"description": "The name of the parent reservation and parent block. In the format of reservations/{reservation_name}/reservationBlocks/{reservation_block_name}", +"location": "path", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, +"reservationSubBlock": { +"description": "The name of the reservation subBlock. Name should conform to RFC1035 or be a resource ID.", +"location": "path", +"required": true, +"type": "string" +}, "zone": { -"description": "Name of the zone for this request.", +"description": "Name of the zone for this request. Zone name should conform to RFC1035.", "location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" } }, -"path": "projects/{project}/zones/{zone}/reservations/{reservation}", +"path": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/reportFaulty", "request": { -"$ref": "Reservation" +"$ref": "ReservationSubBlocksReportFaultyRequest" }, "response": { "$ref": "Operation" @@ -35576,13 +36099,13 @@ } } }, -"resourcePolicies": { +"reservations": { "methods": { "aggregatedList": { -"description": "Retrieves an aggregated list of resource policies. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", -"flatPath": "projects/{project}/aggregated/resourcePolicies", +"description": "Retrieves an aggregated list of reservations. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", +"flatPath": "projects/{project}/aggregated/reservations", "httpMethod": "GET", -"id": "compute.resourcePolicies.aggregatedList", +"id": "compute.reservations.aggregatedList", "parameterOrder": [ "project" ], @@ -35634,9 +36157,9 @@ "type": "string" } }, -"path": "projects/{project}/aggregated/resourcePolicies", +"path": "projects/{project}/aggregated/reservations", "response": { -"$ref": "ResourcePolicyAggregatedList" +"$ref": "ReservationAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -35645,14 +36168,14 @@ ] }, "delete": { -"description": "Deletes the specified resource policy.", -"flatPath": "projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}", +"description": "Deletes the specified reservation.", +"flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}", "httpMethod": "DELETE", -"id": "compute.resourcePolicies.delete", +"id": "compute.reservations.delete", "parameterOrder": [ "project", -"region", -"resourcePolicy" +"zone", +"reservation" ], "parameters": { "project": { @@ -35662,27 +36185,27 @@ "required": true, "type": "string" }, -"region": { -"description": "Name of the region for this request.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", -"required": true, -"type": "string" -}, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, -"resourcePolicy": { -"description": "Name of the resource policy to delete.", +"reservation": { +"description": "Name of the reservation to delete.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" +}, +"zone": { +"description": "Name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" } }, -"path": "projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}", +"path": "projects/{project}/zones/{zone}/reservations/{reservation}", "response": { "$ref": "Operation" }, @@ -35692,14 +36215,14 @@ ] }, "get": { -"description": "Retrieves all information of the specified resource policy.", -"flatPath": "projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}", +"description": "Retrieves information about the specified reservation.", +"flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}", "httpMethod": "GET", -"id": "compute.resourcePolicies.get", +"id": "compute.reservations.get", "parameterOrder": [ "project", -"region", -"resourcePolicy" +"zone", +"reservation" ], "parameters": { "project": { @@ -35709,24 +36232,24 @@ "required": true, "type": "string" }, -"region": { -"description": "Name of the region for this request.", +"reservation": { +"description": "Name of the reservation to retrieve.", "location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" }, -"resourcePolicy": { -"description": "Name of the resource policy to retrieve.", +"zone": { +"description": "Name of the zone for this request.", "location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" } }, -"path": "projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}", +"path": "projects/{project}/zones/{zone}/reservations/{reservation}", "response": { -"$ref": "ResourcePolicy" +"$ref": "Reservation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -35736,12 +36259,12 @@ }, "getIamPolicy": { "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.", -"flatPath": "projects/{project}/regions/{region}/resourcePolicies/{resource}/getIamPolicy", +"flatPath": "projects/{project}/zones/{zone}/reservations/{resource}/getIamPolicy", "httpMethod": "GET", -"id": "compute.resourcePolicies.getIamPolicy", +"id": "compute.reservations.getIamPolicy", "parameterOrder": [ "project", -"region", +"zone", "resource" ], "parameters": { @@ -35758,22 +36281,22 @@ "required": true, "type": "string" }, -"region": { -"description": "The name of the region for this request.", +"resource": { +"description": "Name or id of the resource for this request.", "location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" }, -"resource": { -"description": "Name or id of the resource for this request.", +"zone": { +"description": "The name of the zone for this request.", "location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" } }, -"path": "projects/{project}/regions/{region}/resourcePolicies/{resource}/getIamPolicy", +"path": "projects/{project}/zones/{zone}/reservations/{resource}/getIamPolicy", "response": { "$ref": "Policy" }, @@ -35784,13 +36307,13 @@ ] }, "insert": { -"description": "Creates a new resource policy.", -"flatPath": "projects/{project}/regions/{region}/resourcePolicies", +"description": "Creates a new reservation. For more information, read Reserving zonal resources.", +"flatPath": "projects/{project}/zones/{zone}/reservations", "httpMethod": "POST", -"id": "compute.resourcePolicies.insert", +"id": "compute.reservations.insert", "parameterOrder": [ "project", -"region" +"zone" ], "parameters": { "project": { @@ -35800,22 +36323,22 @@ "required": true, "type": "string" }, -"region": { -"description": "Name of the region for this request.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", -"required": true, -"type": "string" -}, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" +}, +"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}/regions/{region}/resourcePolicies", +"path": "projects/{project}/zones/{zone}/reservations", "request": { -"$ref": "ResourcePolicy" +"$ref": "Reservation" }, "response": { "$ref": "Operation" @@ -35826,13 +36349,13 @@ ] }, "list": { -"description": "A list all the resource policies that have been configured for the specified project in specified region.", -"flatPath": "projects/{project}/regions/{region}/resourcePolicies", +"description": "A list of all the reservations that have been configured for the specified project in specified zone.", +"flatPath": "projects/{project}/zones/{zone}/reservations", "httpMethod": "GET", -"id": "compute.resourcePolicies.list", +"id": "compute.reservations.list", "parameterOrder": [ "project", -"region" +"zone" ], "parameters": { "filter": { @@ -35865,22 +36388,22 @@ "required": true, "type": "string" }, -"region": { -"description": "Name of the region for this request.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", -"required": true, -"type": "string" -}, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" +}, +"zone": { +"description": "Name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" } }, -"path": "projects/{project}/regions/{region}/resourcePolicies", +"path": "projects/{project}/zones/{zone}/reservations", "response": { -"$ref": "ResourcePolicyList" +"$ref": "ReservationList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -35888,28 +36411,69 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, -"patch": { -"description": "Modify the specified resource policy.", -"flatPath": "projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}", -"httpMethod": "PATCH", -"id": "compute.resourcePolicies.patch", +"performMaintenance": { +"description": "Perform maintenance on an extended reservation", +"flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}/performMaintenance", +"httpMethod": "POST", +"id": "compute.reservations.performMaintenance", "parameterOrder": [ "project", -"region", -"resourcePolicy" +"zone", +"reservation" ], "parameters": { "project": { "description": "Project ID for this request.", "location": "path", -"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "required": true, "type": "string" }, -"region": { -"description": "Name of the region for this request.", +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"reservation": { +"description": "The name of the reservation. Name should conform to RFC1035 or be a resource ID.", "location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"zone": { +"description": "Name of the zone for this request. Zone name should conform to RFC1035.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/reservations/{reservation}/performMaintenance", +"request": { +"$ref": "ReservationsPerformMaintenanceRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"resize": { +"description": "Resizes the reservation (applicable to standalone reservations only). For more information, read Modifying reservations.", +"flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}/resize", +"httpMethod": "POST", +"id": "compute.reservations.resize", +"parameterOrder": [ +"project", +"zone", +"reservation" +], +"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" }, @@ -35918,23 +36482,24 @@ "location": "query", "type": "string" }, -"resourcePolicy": { -"description": "Id of the resource policy to patch.", +"reservation": { +"description": "Name of the reservation to update.", "location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, -"updateMask": { -"description": "update_mask indicates fields to be updated as part of this request.", -"format": "google-fieldmask", -"location": "query", +"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}/regions/{region}/resourcePolicies/{resourcePolicy}", +"path": "projects/{project}/zones/{zone}/reservations/{reservation}/resize", "request": { -"$ref": "ResourcePolicy" +"$ref": "ReservationsResizeRequest" }, "response": { "$ref": "Operation" @@ -35946,12 +36511,12 @@ }, "setIamPolicy": { "description": "Sets the access control policy on the specified resource. Replaces any existing policy.", -"flatPath": "projects/{project}/regions/{region}/resourcePolicies/{resource}/setIamPolicy", +"flatPath": "projects/{project}/zones/{zone}/reservations/{resource}/setIamPolicy", "httpMethod": "POST", -"id": "compute.resourcePolicies.setIamPolicy", +"id": "compute.reservations.setIamPolicy", "parameterOrder": [ "project", -"region", +"zone", "resource" ], "parameters": { @@ -35962,24 +36527,24 @@ "required": true, "type": "string" }, -"region": { -"description": "The name of the region for this request.", +"resource": { +"description": "Name or id of the resource for this request.", "location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" }, -"resource": { -"description": "Name or id of the resource for this request.", +"zone": { +"description": "The name of the zone for this request.", "location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" } }, -"path": "projects/{project}/regions/{region}/resourcePolicies/{resource}/setIamPolicy", +"path": "projects/{project}/zones/{zone}/reservations/{resource}/setIamPolicy", "request": { -"$ref": "RegionSetPolicyRequest" +"$ref": "ZoneSetPolicyRequest" }, "response": { "$ref": "Policy" @@ -35991,12 +36556,12 @@ }, "testIamPermissions": { "description": "Returns permissions that a caller has on the specified resource.", -"flatPath": "projects/{project}/regions/{region}/resourcePolicies/{resource}/testIamPermissions", +"flatPath": "projects/{project}/zones/{zone}/reservations/{resource}/testIamPermissions", "httpMethod": "POST", -"id": "compute.resourcePolicies.testIamPermissions", +"id": "compute.reservations.testIamPermissions", "parameterOrder": [ "project", -"region", +"zone", "resource" ], "parameters": { @@ -36007,22 +36572,22 @@ "required": true, "type": "string" }, -"region": { -"description": "The name of the region for this request.", +"resource": { +"description": "Name or id of the resource for this request.", "location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" }, -"resource": { -"description": "Name or id of the resource for this request.", +"zone": { +"description": "The name of the zone for this request.", "location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" } }, -"path": "projects/{project}/regions/{region}/resourcePolicies/{resource}/testIamPermissions", +"path": "projects/{project}/zones/{zone}/reservations/{resource}/testIamPermissions", "request": { "$ref": "TestPermissionsRequest" }, @@ -36034,16 +36599,77 @@ "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ] +}, +"update": { +"description": "Update share settings of the reservation.", +"flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}", +"httpMethod": "PATCH", +"id": "compute.reservations.update", +"parameterOrder": [ +"project", +"zone", +"reservation" +], +"parameters": { +"paths": { +"location": "query", +"repeated": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"reservation": { +"description": "Name of the reservation 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" +}, +"updateMask": { +"description": "Update_mask indicates fields to be updated as part of this request.", +"format": "google-fieldmask", +"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}/reservations/{reservation}", +"request": { +"$ref": "Reservation" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] } } }, -"routers": { +"resourcePolicies": { "methods": { "aggregatedList": { -"description": "Retrieves an aggregated list of routers. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", -"flatPath": "projects/{project}/aggregated/routers", +"description": "Retrieves an aggregated list of resource policies. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", +"flatPath": "projects/{project}/aggregated/resourcePolicies", "httpMethod": "GET", -"id": "compute.routers.aggregatedList", +"id": "compute.resourcePolicies.aggregatedList", "parameterOrder": [ "project" ], @@ -36095,9 +36721,9 @@ "type": "string" } }, -"path": "projects/{project}/aggregated/routers", +"path": "projects/{project}/aggregated/resourcePolicies", "response": { -"$ref": "RouterAggregatedList" +"$ref": "ResourcePolicyAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -36106,14 +36732,14 @@ ] }, "delete": { -"description": "Deletes the specified Router resource.", -"flatPath": "projects/{project}/regions/{region}/routers/{router}", +"description": "Deletes the specified resource policy.", +"flatPath": "projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}", "httpMethod": "DELETE", -"id": "compute.routers.delete", +"id": "compute.resourcePolicies.delete", "parameterOrder": [ "project", "region", -"router" +"resourcePolicy" ], "parameters": { "project": { @@ -36135,15 +36761,15 @@ "location": "query", "type": "string" }, -"router": { -"description": "Name of the Router resource to delete.", +"resourcePolicy": { +"description": "Name of the resource policy to delete.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, -"path": "projects/{project}/regions/{region}/routers/{router}", +"path": "projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}", "response": { "$ref": "Operation" }, @@ -36152,22 +36778,17 @@ "https://www.googleapis.com/auth/compute" ] }, -"deleteRoutePolicy": { -"description": "Deletes Route Policy", -"flatPath": "projects/{project}/regions/{region}/routers/{router}/deleteRoutePolicy", -"httpMethod": "POST", -"id": "compute.routers.deleteRoutePolicy", +"get": { +"description": "Retrieves all information of the specified resource policy.", +"flatPath": "projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}", +"httpMethod": "GET", +"id": "compute.resourcePolicies.get", "parameterOrder": [ "project", "region", -"router" +"resourcePolicy" ], "parameters": { -"policy": { -"description": "The Policy name for this request. Name must conform to RFC1035", -"location": "query", -"type": "string" -}, "project": { "description": "Project ID for this request.", "location": "path", @@ -36182,39 +36803,41 @@ "required": true, "type": "string" }, -"requestId": { -"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", -"location": "query", -"type": "string" -}, -"router": { -"description": "Name of the Router resource where Route Policy is defined.", +"resourcePolicy": { +"description": "Name of the resource policy to retrieve.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, -"path": "projects/{project}/regions/{region}/routers/{router}/deleteRoutePolicy", +"path": "projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}", "response": { -"$ref": "Operation" +"$ref": "ResourcePolicy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute" +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" ] }, -"get": { -"description": "Returns the specified Router resource.", -"flatPath": "projects/{project}/regions/{region}/routers/{router}", +"getIamPolicy": { +"description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.", +"flatPath": "projects/{project}/regions/{region}/resourcePolicies/{resource}/getIamPolicy", "httpMethod": "GET", -"id": "compute.routers.get", +"id": "compute.resourcePolicies.getIamPolicy", "parameterOrder": [ "project", "region", -"router" +"resource" ], "parameters": { +"optionsRequestedPolicyVersion": { +"description": "Requested IAM Policy version.", +"format": "int32", +"location": "query", +"type": "integer" +}, "project": { "description": "Project ID for this request.", "location": "path", @@ -36223,23 +36846,23 @@ "type": "string" }, "region": { -"description": "Name of the region for this request.", +"description": "The name of the region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, -"router": { -"description": "Name of the Router resource to return.", +"resource": { +"description": "Name or id of the resource for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, -"path": "projects/{project}/regions/{region}/routers/{router}", +"path": "projects/{project}/regions/{region}/resourcePolicies/{resource}/getIamPolicy", "response": { -"$ref": "Router" +"$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -36247,22 +36870,16 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, -"getNatIpInfo": { -"description": "Retrieves runtime NAT IP information.", -"flatPath": "projects/{project}/regions/{region}/routers/{router}/getNatIpInfo", -"httpMethod": "GET", -"id": "compute.routers.getNatIpInfo", +"insert": { +"description": "Creates a new resource policy.", +"flatPath": "projects/{project}/regions/{region}/resourcePolicies", +"httpMethod": "POST", +"id": "compute.resourcePolicies.insert", "parameterOrder": [ "project", -"region", -"router" +"region" ], "parameters": { -"natName": { -"description": "Name of the nat service to filter the NAT IP information. If it is omitted, all nats for this router will be returned. Name should conform to RFC1035.", -"location": "query", -"type": "string" -}, "project": { "description": "Project ID for this request.", "location": "path", @@ -36277,32 +36894,32 @@ "required": true, "type": "string" }, -"router": { -"description": "Name of the Router resource to query for Nat IP information. The name should conform to RFC1035.", -"location": "path", -"required": true, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", "type": "string" } }, -"path": "projects/{project}/regions/{region}/routers/{router}/getNatIpInfo", +"path": "projects/{project}/regions/{region}/resourcePolicies", +"request": { +"$ref": "ResourcePolicy" +}, "response": { -"$ref": "NatIpInfoResponse" +"$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] }, -"getNatMappingInfo": { -"description": "Retrieves runtime Nat mapping information of VM endpoints.", -"flatPath": "projects/{project}/regions/{region}/routers/{router}/getNatMappingInfo", +"list": { +"description": "A list all the resource policies that have been configured for the specified project in specified region.", +"flatPath": "projects/{project}/regions/{region}/resourcePolicies", "httpMethod": "GET", -"id": "compute.routers.getNatMappingInfo", +"id": "compute.resourcePolicies.list", "parameterOrder": [ "project", -"region", -"router" +"region" ], "parameters": { "filter": { @@ -36318,11 +36935,6 @@ "minimum": "0", "type": "integer" }, -"natName": { -"description": "Name of the nat service to filter the Nat Mapping information. If it is omitted, all nats for this router will be returned. Name should conform to RFC1035.", -"location": "query", -"type": "string" -}, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", @@ -36351,18 +36963,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" -}, -"router": { -"description": "Name of the Router resource to query for Nat Mapping information of VM endpoints.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", -"required": true, -"type": "string" } }, -"path": "projects/{project}/regions/{region}/routers/{router}/getNatMappingInfo", +"path": "projects/{project}/regions/{region}/resourcePolicies", "response": { -"$ref": "VmEndpointNatMappingsList" +"$ref": "ResourcePolicyList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -36370,22 +36975,17 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, -"getRoutePolicy": { -"description": "Returns specified Route Policy", -"flatPath": "projects/{project}/regions/{region}/routers/{router}/getRoutePolicy", -"httpMethod": "GET", -"id": "compute.routers.getRoutePolicy", +"patch": { +"description": "Modify the specified resource policy.", +"flatPath": "projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}", +"httpMethod": "PATCH", +"id": "compute.resourcePolicies.patch", "parameterOrder": [ "project", "region", -"router" +"resourcePolicy" ], "parameters": { -"policy": { -"description": "The Policy name for this request. Name must conform to RFC1035", -"location": "query", -"type": "string" -}, "project": { "description": "Project ID for this request.", "location": "path", @@ -36400,32 +37000,46 @@ "required": true, "type": "string" }, -"router": { -"description": "Name of the Router resource to query for the route policy. The name should conform to RFC1035.", +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"resourcePolicy": { +"description": "Id of the resource policy 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" +}, +"updateMask": { +"description": "update_mask indicates fields to be updated as part of this request.", +"format": "google-fieldmask", +"location": "query", +"type": "string" } }, -"path": "projects/{project}/regions/{region}/routers/{router}/getRoutePolicy", +"path": "projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}", +"request": { +"$ref": "ResourcePolicy" +}, "response": { -"$ref": "RoutersGetRoutePolicyResponse" +"$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] }, -"getRouterStatus": { -"description": "Retrieves runtime information of the specified router.", -"flatPath": "projects/{project}/regions/{region}/routers/{router}/getRouterStatus", -"httpMethod": "GET", -"id": "compute.routers.getRouterStatus", +"setIamPolicy": { +"description": "Sets the access control policy on the specified resource. Replaces any existing policy.", +"flatPath": "projects/{project}/regions/{region}/resourcePolicies/{resource}/setIamPolicy", +"httpMethod": "POST", +"id": "compute.resourcePolicies.setIamPolicy", "parameterOrder": [ "project", "region", -"router" +"resource" ], "parameters": { "project": { @@ -36436,38 +37050,41 @@ "type": "string" }, "region": { -"description": "Name of the region for this request.", +"description": "The name of the region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, -"router": { -"description": "Name of the Router resource to query.", +"resource": { +"description": "Name or id of the resource for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, -"path": "projects/{project}/regions/{region}/routers/{router}/getRouterStatus", +"path": "projects/{project}/regions/{region}/resourcePolicies/{resource}/setIamPolicy", +"request": { +"$ref": "RegionSetPolicyRequest" +}, "response": { -"$ref": "RouterStatusResponse" +"$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] }, -"insert": { -"description": "Creates a Router resource in the specified project and region using the data included in the request.", -"flatPath": "projects/{project}/regions/{region}/routers", +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified resource.", +"flatPath": "projects/{project}/regions/{region}/resourcePolicies/{resource}/testIamPermissions", "httpMethod": "POST", -"id": "compute.routers.insert", +"id": "compute.resourcePolicies.testIamPermissions", "parameterOrder": [ "project", -"region" +"region", +"resource" ], "parameters": { "project": { @@ -36478,38 +37095,44 @@ "type": "string" }, "region": { -"description": "Name of the region for this request.", +"description": "The name of the region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, -"requestId": { -"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", -"location": "query", +"resource": { +"description": "Name or id of the resource for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, "type": "string" } }, -"path": "projects/{project}/regions/{region}/routers", +"path": "projects/{project}/regions/{region}/resourcePolicies/{resource}/testIamPermissions", "request": { -"$ref": "Router" +"$ref": "TestPermissionsRequest" }, "response": { -"$ref": "Operation" +"$ref": "TestPermissionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute" +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" ] +} +} }, -"list": { -"description": "Retrieves a list of Router resources available to the specified project.", -"flatPath": "projects/{project}/regions/{region}/routers", +"routers": { +"methods": { +"aggregatedList": { +"description": "Retrieves an aggregated list of routers. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", +"flatPath": "projects/{project}/aggregated/routers", "httpMethod": "GET", -"id": "compute.routers.list", +"id": "compute.routers.aggregatedList", "parameterOrder": [ -"project", -"region" +"project" ], "parameters": { "filter": { @@ -36517,6 +37140,11 @@ "location": "query", "type": "string" }, +"includeAllScopes": { +"description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", +"location": "query", +"type": "boolean" +}, "maxResults": { "default": "500", "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", @@ -36542,22 +37170,481 @@ "required": true, "type": "string" }, -"region": { -"description": "Name of the region for this request.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", -"required": true, -"type": "string" -}, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" -} -}, -"path": "projects/{project}/regions/{region}/routers", -"response": { -"$ref": "RouterList" +}, +"serviceProjectNumber": { +"description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/aggregated/routers", +"response": { +"$ref": "RouterAggregatedList" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"delete": { +"description": "Deletes the specified Router resource.", +"flatPath": "projects/{project}/regions/{region}/routers/{router}", +"httpMethod": "DELETE", +"id": "compute.routers.delete", +"parameterOrder": [ +"project", +"region", +"router" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"router": { +"description": "Name of the Router resource to delete.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/routers/{router}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"deleteRoutePolicy": { +"description": "Deletes Route Policy", +"flatPath": "projects/{project}/regions/{region}/routers/{router}/deleteRoutePolicy", +"httpMethod": "POST", +"id": "compute.routers.deleteRoutePolicy", +"parameterOrder": [ +"project", +"region", +"router" +], +"parameters": { +"policy": { +"description": "The Policy name for this request. Name must conform to RFC1035", +"location": "query", +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"router": { +"description": "Name of the Router resource where Route Policy is defined.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/routers/{router}/deleteRoutePolicy", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"get": { +"description": "Returns the specified Router resource.", +"flatPath": "projects/{project}/regions/{region}/routers/{router}", +"httpMethod": "GET", +"id": "compute.routers.get", +"parameterOrder": [ +"project", +"region", +"router" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"router": { +"description": "Name of the Router resource to return.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/routers/{router}", +"response": { +"$ref": "Router" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"getNatIpInfo": { +"description": "Retrieves runtime NAT IP information.", +"flatPath": "projects/{project}/regions/{region}/routers/{router}/getNatIpInfo", +"httpMethod": "GET", +"id": "compute.routers.getNatIpInfo", +"parameterOrder": [ +"project", +"region", +"router" +], +"parameters": { +"natName": { +"description": "Name of the nat service to filter the NAT IP information. If it is omitted, all nats for this router will be returned. Name should conform to RFC1035.", +"location": "query", +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"router": { +"description": "Name of the Router resource to query for Nat IP information. The name should conform to RFC1035.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/routers/{router}/getNatIpInfo", +"response": { +"$ref": "NatIpInfoResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"getNatMappingInfo": { +"description": "Retrieves runtime Nat mapping information of VM endpoints.", +"flatPath": "projects/{project}/regions/{region}/routers/{router}/getNatMappingInfo", +"httpMethod": "GET", +"id": "compute.routers.getNatMappingInfo", +"parameterOrder": [ +"project", +"region", +"router" +], +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", +"location": "query", +"type": "string" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"natName": { +"description": "Name of the nat service to filter the Nat Mapping information. If it is omitted, all nats for this router will be returned. Name should conform to RFC1035.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", +"location": "query", +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", +"location": "query", +"type": "boolean" +}, +"router": { +"description": "Name of the Router resource to query for Nat Mapping information of VM endpoints.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/routers/{router}/getNatMappingInfo", +"response": { +"$ref": "VmEndpointNatMappingsList" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"getRoutePolicy": { +"description": "Returns specified Route Policy", +"flatPath": "projects/{project}/regions/{region}/routers/{router}/getRoutePolicy", +"httpMethod": "GET", +"id": "compute.routers.getRoutePolicy", +"parameterOrder": [ +"project", +"region", +"router" +], +"parameters": { +"policy": { +"description": "The Policy name for this request. Name must conform to RFC1035", +"location": "query", +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"router": { +"description": "Name of the Router resource to query for the route policy. The name should conform to RFC1035.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/routers/{router}/getRoutePolicy", +"response": { +"$ref": "RoutersGetRoutePolicyResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"getRouterStatus": { +"description": "Retrieves runtime information of the specified router.", +"flatPath": "projects/{project}/regions/{region}/routers/{router}/getRouterStatus", +"httpMethod": "GET", +"id": "compute.routers.getRouterStatus", +"parameterOrder": [ +"project", +"region", +"router" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"router": { +"description": "Name of the Router resource to query.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/routers/{router}/getRouterStatus", +"response": { +"$ref": "RouterStatusResponse" +}, +"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 Router resource in the specified project and region using the data included in the request.", +"flatPath": "projects/{project}/regions/{region}/routers", +"httpMethod": "POST", +"id": "compute.routers.insert", +"parameterOrder": [ +"project", +"region" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/routers", +"request": { +"$ref": "Router" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"list": { +"description": "Retrieves a list of Router resources available to the specified project.", +"flatPath": "projects/{project}/regions/{region}/routers", +"httpMethod": "GET", +"id": "compute.routers.list", +"parameterOrder": [ +"project", +"region" +], +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", +"location": "query", +"type": "string" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", +"location": "query", +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", +"location": "query", +"type": "boolean" +} +}, +"path": "projects/{project}/regions/{region}/routers", +"response": { +"$ref": "RouterList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -45766,7 +46853,7 @@ } } }, -"revision": "20250909", +"revision": "20250916", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -46413,6 +47500,10 @@ false "format": "uint64", "type": "string" }, +"ipCollection": { +"description": "Reference to the source of external IPv4 addresses, like a PublicDelegatedPrefix (PDP) for BYOIP. The PDP must support enhanced IPv4 allocations. Use one of the following formats to specify a PDP when reserving an external IPv4 address using BYOIP. - Full resource URL, as in https://www.googleapis.com/compute/v1/projects/projectId/regions/region /publicDelegatedPrefixes/pdp-name - Partial URL, as in - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name - regions/region/publicDelegatedPrefixes/pdp-name ", +"type": "string" +}, "ipVersion": { "description": "The IP version that will be used by this address. Valid options are IPV4 or IPV6.", "enum": [ @@ -59025,359 +60116,10 @@ false }, "type": "object" }, -"HealthStatus": { -"id": "HealthStatus", +"HealthSource": { +"description": "Represents a health source. A health source resource specifies the source resources and the health aggregation policy applied to the source resources to determine the aggregated health status.", +"id": "HealthSource", "properties": { -"annotations": { -"additionalProperties": { -"type": "string" -}, -"description": "Metadata defined as annotations for network endpoint.", -"type": "object" -}, -"forwardingRule": { -"description": "URL of the forwarding rule associated with the health status of the instance.", -"type": "string" -}, -"forwardingRuleIp": { -"description": "A forwarding rule IP address assigned to this instance.", -"type": "string" -}, -"healthState": { -"description": "Health state of the IPv4 address of the instance.", -"enum": [ -"HEALTHY", -"UNHEALTHY" -], -"enumDescriptions": [ -"", -"" -], -"type": "string" -}, -"instance": { -"description": "URL of the instance resource.", -"type": "string" -}, -"ipAddress": { -"description": "For target pool based Network Load Balancing, it indicates the forwarding rule's IP address assigned to this instance. For other types of load balancing, the field indicates VM internal ip.", -"type": "string" -}, -"ipv6Address": { -"type": "string" -}, -"ipv6HealthState": { -"description": "Health state of the IPv6 address of the instance.", -"enum": [ -"HEALTHY", -"UNHEALTHY" -], -"enumDescriptions": [ -"", -"" -], -"type": "string" -}, -"port": { -"description": "The named port of the instance group, not necessarily the port that is health-checked.", -"format": "int32", -"type": "integer" -}, -"weight": { -"type": "string" -}, -"weightError": { -"enum": [ -"INVALID_WEIGHT", -"MISSING_WEIGHT", -"UNAVAILABLE_WEIGHT", -"WEIGHT_NONE" -], -"enumDescriptions": [ -"The response to a Health Check probe had the HTTP response header field X-Load-Balancing-Endpoint-Weight, but its content was invalid (i.e., not a non-negative single-precision floating-point number in decimal string representation).", -"The response to a Health Check probe did not have the HTTP response header field X-Load-Balancing-Endpoint-Weight.", -"This is the value when the accompanied health status is either TIMEOUT (i.e.,the Health Check probe was not able to get a response in time) or UNKNOWN. For the latter, it should be typically because there has not been sufficient time to parse and report the weight for a new backend (which is with 0.0.0.0 ip address). However, it can be also due to an outage case for which the health status is explicitly reset to UNKNOWN.", -"This is the default value when WeightReportMode is DISABLE, and is also the initial value when WeightReportMode has just updated to ENABLE or DRY_RUN and there has not been sufficient time to parse and report the backend weight." -], -"type": "string" -} -}, -"type": "object" -}, -"HealthStatusForNetworkEndpoint": { -"id": "HealthStatusForNetworkEndpoint", -"properties": { -"backendService": { -"$ref": "BackendServiceReference", -"description": "URL of the backend service associated with the health state of the network endpoint." -}, -"forwardingRule": { -"$ref": "ForwardingRuleReference", -"description": "URL of the forwarding rule associated with the health state of the network endpoint." -}, -"healthCheck": { -"$ref": "HealthCheckReference", -"description": "URL of the health check associated with the health state of the network endpoint." -}, -"healthCheckService": { -"$ref": "HealthCheckServiceReference", -"description": "URL of the health check service associated with the health state of the network endpoint." -}, -"healthState": { -"description": "Health state of the network endpoint determined based on the health checks configured.", -"enum": [ -"DRAINING", -"HEALTHY", -"UNHEALTHY", -"UNKNOWN" -], -"enumDescriptions": [ -"Endpoint is being drained.", -"Endpoint is healthy.", -"Endpoint is unhealthy.", -"Health status of the endpoint is unknown." -], -"type": "string" -}, -"ipv6HealthState": { -"description": "Health state of the ipv6 network endpoint determined based on the health checks configured.", -"enum": [ -"DRAINING", -"HEALTHY", -"UNHEALTHY", -"UNKNOWN" -], -"enumDescriptions": [ -"Endpoint is being drained.", -"Endpoint is healthy.", -"Endpoint is unhealthy.", -"Health status of the endpoint is unknown." -], -"type": "string" -} -}, -"type": "object" -}, -"Help": { -"description": "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.", -"id": "Help", -"properties": { -"links": { -"description": "URL(s) pointing to additional information on handling the current error.", -"items": { -"$ref": "HelpLink" -}, -"type": "array" -} -}, -"type": "object" -}, -"HelpLink": { -"description": "Describes a URL link.", -"id": "HelpLink", -"properties": { -"description": { -"description": "Describes what the link offers.", -"type": "string" -}, -"url": { -"description": "The URL of the link.", -"type": "string" -} -}, -"type": "object" -}, -"HostRule": { -"description": "UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.", -"id": "HostRule", -"properties": { -"description": { -"description": "An optional description of this resource. Provide this property when you create the resource.", -"type": "string" -}, -"hosts": { -"description": "The list of host patterns to match. They must be valid hostnames with optional port numbers in the format host:port. * matches any string of ([a-z0-9-.]*). In that case, * must be the first character, and if followed by anything, the immediate following character must be either - or .. * based matching is not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.", -"items": { -"type": "string" -}, -"type": "array" -}, -"pathMatcher": { -"description": "The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.", -"type": "string" -} -}, -"type": "object" -}, -"HttpFaultAbort": { -"description": "Specification for how requests are aborted as part of fault injection.", -"id": "HttpFaultAbort", -"properties": { -"httpStatus": { -"description": "The HTTP status code used to abort the request. The value must be from 200 to 599 inclusive. For gRPC protocol, the gRPC status code is mapped to HTTP status code according to this mapping table. HTTP status 200 is mapped to gRPC status UNKNOWN. Injecting an OK status is currently not supported by Traffic Director.", -"format": "uint32", -"type": "integer" -}, -"percentage": { -"description": "The percentage of traffic for connections, operations, or requests that is aborted as part of fault injection. The value must be from 0.0 to 100.0 inclusive.", -"format": "double", -"type": "number" -} -}, -"type": "object" -}, -"HttpFaultDelay": { -"description": "Specifies the delay introduced by the load balancer before forwarding the request to the backend service as part of fault injection.", -"id": "HttpFaultDelay", -"properties": { -"fixedDelay": { -"$ref": "Duration", -"description": "Specifies the value of the fixed delay interval." -}, -"percentage": { -"description": "The percentage of traffic for connections, operations, or requests for which a delay is introduced as part of fault injection. The value must be from 0.0 to 100.0 inclusive.", -"format": "double", -"type": "number" -} -}, -"type": "object" -}, -"HttpFaultInjection": { -"description": "The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by the load balancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the load balancer for a percentage of requests.", -"id": "HttpFaultInjection", -"properties": { -"abort": { -"$ref": "HttpFaultAbort", -"description": "The specification for how client requests are aborted as part of fault injection." -}, -"delay": { -"$ref": "HttpFaultDelay", -"description": "The specification for how client requests are delayed as part of fault injection, before being sent to a backend service." -} -}, -"type": "object" -}, -"HttpFilterConfig": { -"description": "HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.", -"id": "HttpFilterConfig", -"properties": { -"config": { -"description": "The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl", -"type": "string" -}, -"configTypeUrl": { -"description": "The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct", -"type": "string" -}, -"filterName": { -"description": "Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm", -"type": "string" -} -}, -"type": "object" -}, -"HttpHeaderAction": { -"description": "The request and response header transformations that take effect before the request is passed along to the selected backendService.", -"id": "HttpHeaderAction", -"properties": { -"requestHeadersToAdd": { -"description": "Headers to add to a matching request before forwarding the request to the backendService.", -"items": { -"$ref": "HttpHeaderOption" -}, -"type": "array" -}, -"requestHeadersToRemove": { -"description": "A list of header names for headers that need to be removed from the request before forwarding the request to the backendService.", -"items": { -"type": "string" -}, -"type": "array" -}, -"responseHeadersToAdd": { -"description": "Headers to add the response before sending the response back to the client.", -"items": { -"$ref": "HttpHeaderOption" -}, -"type": "array" -}, -"responseHeadersToRemove": { -"description": "A list of header names for headers that need to be removed from the response before sending the response back to the client.", -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, -"HttpHeaderMatch": { -"description": "matchRule criteria for request header matches.", -"id": "HttpHeaderMatch", -"properties": { -"exactMatch": { -"description": "The value should exactly match contents of exactMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.", -"type": "string" -}, -"headerName": { -"description": "The name of the HTTP header to match. For matching against the HTTP request's authority, use a headerMatch with the header name \":authority\". For matching a request's method, use the headerName \":method\". When the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true, only non-binary user-specified custom metadata and the `content-type` header are supported. The following transport-level headers cannot be used in header matching rules: `:authority`, `:method`, `:path`, `:scheme`, `user-agent`, `accept-encoding`, `content-encoding`, `grpc-accept-encoding`, `grpc-encoding`, `grpc-previous-rpc-attempts`, `grpc-tags-bin`, `grpc-timeout` and `grpc-trace-bin`.", -"type": "string" -}, -"invertMatch": { -"description": "If set to false, the headerMatch is considered a match if the preceding match criteria are met. If set to true, the headerMatch is considered a match if the preceding match criteria are NOT met. The default setting is false. ", -"type": "boolean" -}, -"prefixMatch": { -"description": "The value of the header must start with the contents of prefixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.", -"type": "string" -}, -"presentMatch": { -"description": "A header with the contents of headerName must exist. The match takes place whether or not the request's header has a value. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.", -"type": "boolean" -}, -"rangeMatch": { -"$ref": "Int64RangeMatch", -"description": "The header value must be an integer and its value must be in the range specified in rangeMatch. If the header does not contain an integer, number or is empty, the match fails. For example for a range [-5, 0] - -3 will match. - 0 will not match. - 0.25 will not match. - -3someString will not match. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. rangeMatch is not supported for load balancers that have loadBalancingScheme set to EXTERNAL." -}, -"regexMatch": { -"description": "The value of the header must match the regular expression specified in regexMatch. For more information about regular expression syntax, see Syntax. For matching against a port specified in the HTTP request, use a headerMatch with headerName set to PORT and a regular expression that satisfies the RFC2616 Host header's port specifier. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.", -"type": "string" -}, -"suffixMatch": { -"description": "The value of the header must end with the contents of suffixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.", -"type": "string" -} -}, -"type": "object" -}, -"HttpHeaderOption": { -"description": "Specification determining how headers are added to requests or responses.", -"id": "HttpHeaderOption", -"properties": { -"headerName": { -"description": "The name of the header.", -"type": "string" -}, -"headerValue": { -"description": "The value of the header to add.", -"type": "string" -}, -"replace": { -"description": "If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is true, unless a variable is present in headerValue, in which case the default value is false. .", -"type": "boolean" -} -}, -"type": "object" -}, -"HttpHealthCheck": { -"description": "Represents a legacy HTTP Health Check resource. Legacy HTTP health checks are now only required by target pool-based network load balancers. For all other load balancers, including backend service-based network load balancers, and for managed instance group auto-healing, you must use modern (non-legacy) health checks. For more information, see Health checks overview .", -"id": "HttpHealthCheck", -"properties": { -"checkIntervalSec": { -"description": "How often (in seconds) to send a health check. The default value is 5 seconds.", -"format": "int32", -"type": "integer" -}, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" @@ -59386,23 +60128,23 @@ false "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, -"healthyThreshold": { -"description": "A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.", -"format": "int32", -"type": "integer" +"fingerprint": { +"description": "Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a HealthSource. An up-to-date fingerprint must be provided in order to patch the HealthSource; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthSource.", +"format": "byte", +"type": "string" }, -"host": { -"description": "The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.", +"healthAggregationPolicy": { +"description": "URL to the HealthAggregationPolicy resource. Must be set. Must be regional and in the same region as the HealthSource. Can be mutated.", "type": "string" }, "id": { -"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", +"description": "[Output Only] A unique identifier for this resource type. The server generates this identifier.", "format": "uint64", "type": "string" }, "kind": { -"default": "compute#httpHealthCheck", -"description": "[Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.", +"default": "compute#healthSource", +"description": "[Output Only] Type of the resource. Always compute#healthSource for health sources.", "type": "string" }, "name": { @@ -59410,49 +60152,913 @@ false "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, -"port": { -"description": "The TCP port number for the HTTP health check request. The default value is 80.", -"format": "int32", -"type": "integer" -}, -"requestPath": { -"description": "The request path of the HTTP health check request. The default value is /. This field does not support query parameters. Must comply with RFC3986.", +"region": { +"description": "[Output Only] URL of the region where the health source resides. This field applies only to the regional resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, -"timeoutSec": { -"description": "How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.", -"format": "int32", -"type": "integer" +"selfLinkWithId": { +"description": "[Output Only] Server-defined URL with id for the resource.", +"type": "string" }, -"unhealthyThreshold": { -"description": "A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.", -"format": "int32", -"type": "integer" +"sourceType": { +"description": "Specifies the type of the HealthSource. The only allowed value is BACKEND_SERVICE. Must be specified when the HealthSource is created, and cannot be mutated.", +"enum": [ +"BACKEND_SERVICE" +], +"enumDescriptions": [ +"" +], +"type": "string" +}, +"sources": { +"description": "URLs to the source resources. Must be size 1. Must be a BackendService if the sourceType is BACKEND_SERVICE. The BackendService must have load balancing scheme INTERNAL or INTERNAL_MANAGED and must be regional and in the same region as the HealthSource (cross-region deployment for INTERNAL_MANAGED is not supported). The BackendService may use only IGs, MIGs, or NEGs of type GCE_VM_IP or GCE_VM_IP_PORT. The BackendService may not use haPolicy. Can be mutated.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" }, -"HttpHealthCheckList": { -"description": "Contains a list of HttpHealthCheck resources.", -"id": "HttpHealthCheckList", +"HealthSourceAggregatedList": { +"description": "Contains a list of HealthSourcesScopedList.", +"id": "HealthSourceAggregatedList", "properties": { "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { -"description": "A list of HttpHealthCheck resources.", -"items": { -"$ref": "HttpHealthCheck" +"additionalProperties": { +"$ref": "HealthSourcesScopedList", +"description": "Name of the scope containing this set of HealthSources." }, -"type": "array" +"description": "A list of HealthSourcesScopedList resources.", +"type": "object" }, "kind": { -"default": "compute#httpHealthCheckList", +"default": "compute#healthSourceAggregatedList", +"description": "Type of resource.", +"type": "string" +}, +"nextPageToken": { +"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", +"type": "string" +}, +"selfLink": { +"description": "[Output Only] Server-defined URL for this resource.", +"type": "string" +}, +"warning": { +"description": "[Output Only] Informational warning message.", +"properties": { +"code": { +"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", +"enum": [ +"CLEANUP_FAILED", +"DEPRECATED_RESOURCE_USED", +"DEPRECATED_TYPE_USED", +"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", +"EXPERIMENTAL_TYPE_USED", +"EXTERNAL_API_WARNING", +"FIELD_VALUE_OVERRIDEN", +"INJECTED_KERNELS_DEPRECATED", +"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", +"LARGE_DEPLOYMENT_WARNING", +"LIST_OVERHEAD_QUOTA_EXCEED", +"MISSING_TYPE_DEPENDENCY", +"NEXT_HOP_ADDRESS_NOT_ASSIGNED", +"NEXT_HOP_CANNOT_IP_FORWARD", +"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", +"NEXT_HOP_INSTANCE_NOT_FOUND", +"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", +"NEXT_HOP_NOT_RUNNING", +"NOT_CRITICAL_ERROR", +"NO_RESULTS_ON_PAGE", +"PARTIAL_SUCCESS", +"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 operation.", +"A link to a deprecated resource was created.", +"When deploying and at least one of the resources has a type marked as deprecated", +"The user created a boot disk that is larger than image size.", +"When deploying and at least one of the resources has a type marked as experimental", +"Warning that is present in an external api call", +"Warning that value of a field has been overridden. Deprecated unused field.", +"The operation involved use of an injected kernel, which is deprecated.", +"A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", +"When deploying a deployment with a exceedingly large number of resources", +"Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", +"A resource depends on a missing type", +"The route's nextHopIp address is not assigned to an instance on the network.", +"The route's next hop instance cannot ip forward.", +"The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", +"The route's nextHopInstance URL refers to an instance that does not exist.", +"The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", +"The route's next hop instance does not have a status of RUNNING.", +"Error which is not critical. We decided to continue the process despite the mentioned error.", +"No results are present on a particular list page.", +"Success is reported, but some results may be missing due to errors", +"Quota information is not available to client requests (e.g: regions.list).", +"The user attempted to use a resource that requires a TOS they have not accepted.", +"Warning that a resource is in use.", +"One or more of the resources set to auto-delete could not be deleted because they were in use.", +"When a resource schema validation is ignored.", +"Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", +"When undeclared properties in the schema are present", +"A given scope cannot be reached." +], +"type": "string" +}, +"data": { +"description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", +"type": "string" +}, +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "[Output Only] A human-readable description of the warning code.", +"type": "string" +} +}, +"type": "object" +} +}, +"type": "object" +}, +"HealthSourceList": { +"id": "HealthSourceList", +"properties": { +"id": { +"description": "[Output Only] Unique identifier for the resource; defined by the server.", +"type": "string" +}, +"items": { +"description": "A list of HealthSource resources.", +"items": { +"$ref": "HealthSource" +}, +"type": "array" +}, +"kind": { +"default": "compute#healthSourceList", +"description": "[Output Only] Type of the resource. Always compute#healthSource for health sources.", +"type": "string" +}, +"nextPageToken": { +"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", +"type": "string" +}, +"selfLink": { +"description": "[Output Only] Server-defined URL for this resource.", +"type": "string" +}, +"warning": { +"description": "[Output Only] Informational warning message.", +"properties": { +"code": { +"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", +"enum": [ +"CLEANUP_FAILED", +"DEPRECATED_RESOURCE_USED", +"DEPRECATED_TYPE_USED", +"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", +"EXPERIMENTAL_TYPE_USED", +"EXTERNAL_API_WARNING", +"FIELD_VALUE_OVERRIDEN", +"INJECTED_KERNELS_DEPRECATED", +"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", +"LARGE_DEPLOYMENT_WARNING", +"LIST_OVERHEAD_QUOTA_EXCEED", +"MISSING_TYPE_DEPENDENCY", +"NEXT_HOP_ADDRESS_NOT_ASSIGNED", +"NEXT_HOP_CANNOT_IP_FORWARD", +"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", +"NEXT_HOP_INSTANCE_NOT_FOUND", +"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", +"NEXT_HOP_NOT_RUNNING", +"NOT_CRITICAL_ERROR", +"NO_RESULTS_ON_PAGE", +"PARTIAL_SUCCESS", +"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 operation.", +"A link to a deprecated resource was created.", +"When deploying and at least one of the resources has a type marked as deprecated", +"The user created a boot disk that is larger than image size.", +"When deploying and at least one of the resources has a type marked as experimental", +"Warning that is present in an external api call", +"Warning that value of a field has been overridden. Deprecated unused field.", +"The operation involved use of an injected kernel, which is deprecated.", +"A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", +"When deploying a deployment with a exceedingly large number of resources", +"Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", +"A resource depends on a missing type", +"The route's nextHopIp address is not assigned to an instance on the network.", +"The route's next hop instance cannot ip forward.", +"The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", +"The route's nextHopInstance URL refers to an instance that does not exist.", +"The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", +"The route's next hop instance does not have a status of RUNNING.", +"Error which is not critical. We decided to continue the process despite the mentioned error.", +"No results are present on a particular list page.", +"Success is reported, but some results may be missing due to errors", +"Quota information is not available to client requests (e.g: regions.list).", +"The user attempted to use a resource that requires a TOS they have not accepted.", +"Warning that a resource is in use.", +"One or more of the resources set to auto-delete could not be deleted because they were in use.", +"When a resource schema validation is ignored.", +"Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", +"When undeclared properties in the schema are present", +"A given scope cannot be reached." +], +"type": "string" +}, +"data": { +"description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", +"type": "string" +}, +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "[Output Only] A human-readable description of the warning code.", +"type": "string" +} +}, +"type": "object" +} +}, +"type": "object" +}, +"HealthSourcesScopedList": { +"id": "HealthSourcesScopedList", +"properties": { +"healthSources": { +"description": "A list of HealthSources contained in this scope.", +"items": { +"$ref": "HealthSource" +}, +"type": "array" +}, +"warning": { +"description": "Informational warning which replaces the list of health sources when the list is empty.", +"properties": { +"code": { +"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", +"enum": [ +"CLEANUP_FAILED", +"DEPRECATED_RESOURCE_USED", +"DEPRECATED_TYPE_USED", +"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", +"EXPERIMENTAL_TYPE_USED", +"EXTERNAL_API_WARNING", +"FIELD_VALUE_OVERRIDEN", +"INJECTED_KERNELS_DEPRECATED", +"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", +"LARGE_DEPLOYMENT_WARNING", +"LIST_OVERHEAD_QUOTA_EXCEED", +"MISSING_TYPE_DEPENDENCY", +"NEXT_HOP_ADDRESS_NOT_ASSIGNED", +"NEXT_HOP_CANNOT_IP_FORWARD", +"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", +"NEXT_HOP_INSTANCE_NOT_FOUND", +"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", +"NEXT_HOP_NOT_RUNNING", +"NOT_CRITICAL_ERROR", +"NO_RESULTS_ON_PAGE", +"PARTIAL_SUCCESS", +"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 operation.", +"A link to a deprecated resource was created.", +"When deploying and at least one of the resources has a type marked as deprecated", +"The user created a boot disk that is larger than image size.", +"When deploying and at least one of the resources has a type marked as experimental", +"Warning that is present in an external api call", +"Warning that value of a field has been overridden. Deprecated unused field.", +"The operation involved use of an injected kernel, which is deprecated.", +"A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", +"When deploying a deployment with a exceedingly large number of resources", +"Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", +"A resource depends on a missing type", +"The route's nextHopIp address is not assigned to an instance on the network.", +"The route's next hop instance cannot ip forward.", +"The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", +"The route's nextHopInstance URL refers to an instance that does not exist.", +"The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", +"The route's next hop instance does not have a status of RUNNING.", +"Error which is not critical. We decided to continue the process despite the mentioned error.", +"No results are present on a particular list page.", +"Success is reported, but some results may be missing due to errors", +"Quota information is not available to client requests (e.g: regions.list).", +"The user attempted to use a resource that requires a TOS they have not accepted.", +"Warning that a resource is in use.", +"One or more of the resources set to auto-delete could not be deleted because they were in use.", +"When a resource schema validation is ignored.", +"Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", +"When undeclared properties in the schema are present", +"A given scope cannot be reached." +], +"type": "string" +}, +"data": { +"description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", +"type": "string" +}, +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "[Output Only] A human-readable description of the warning code.", +"type": "string" +} +}, +"type": "object" +} +}, +"type": "object" +}, +"HealthStatus": { +"id": "HealthStatus", +"properties": { +"annotations": { +"additionalProperties": { +"type": "string" +}, +"description": "Metadata defined as annotations for network endpoint.", +"type": "object" +}, +"forwardingRule": { +"description": "URL of the forwarding rule associated with the health status of the instance.", +"type": "string" +}, +"forwardingRuleIp": { +"description": "A forwarding rule IP address assigned to this instance.", +"type": "string" +}, +"healthState": { +"description": "Health state of the IPv4 address of the instance.", +"enum": [ +"HEALTHY", +"UNHEALTHY" +], +"enumDescriptions": [ +"", +"" +], +"type": "string" +}, +"instance": { +"description": "URL of the instance resource.", +"type": "string" +}, +"ipAddress": { +"description": "For target pool based Network Load Balancing, it indicates the forwarding rule's IP address assigned to this instance. For other types of load balancing, the field indicates VM internal ip.", +"type": "string" +}, +"ipv6Address": { +"type": "string" +}, +"ipv6HealthState": { +"description": "Health state of the IPv6 address of the instance.", +"enum": [ +"HEALTHY", +"UNHEALTHY" +], +"enumDescriptions": [ +"", +"" +], +"type": "string" +}, +"port": { +"description": "The named port of the instance group, not necessarily the port that is health-checked.", +"format": "int32", +"type": "integer" +}, +"weight": { +"type": "string" +}, +"weightError": { +"enum": [ +"INVALID_WEIGHT", +"MISSING_WEIGHT", +"UNAVAILABLE_WEIGHT", +"WEIGHT_NONE" +], +"enumDescriptions": [ +"The response to a Health Check probe had the HTTP response header field X-Load-Balancing-Endpoint-Weight, but its content was invalid (i.e., not a non-negative single-precision floating-point number in decimal string representation).", +"The response to a Health Check probe did not have the HTTP response header field X-Load-Balancing-Endpoint-Weight.", +"This is the value when the accompanied health status is either TIMEOUT (i.e.,the Health Check probe was not able to get a response in time) or UNKNOWN. For the latter, it should be typically because there has not been sufficient time to parse and report the weight for a new backend (which is with 0.0.0.0 ip address). However, it can be also due to an outage case for which the health status is explicitly reset to UNKNOWN.", +"This is the default value when WeightReportMode is DISABLE, and is also the initial value when WeightReportMode has just updated to ENABLE or DRY_RUN and there has not been sufficient time to parse and report the backend weight." +], +"type": "string" +} +}, +"type": "object" +}, +"HealthStatusForNetworkEndpoint": { +"id": "HealthStatusForNetworkEndpoint", +"properties": { +"backendService": { +"$ref": "BackendServiceReference", +"description": "URL of the backend service associated with the health state of the network endpoint." +}, +"forwardingRule": { +"$ref": "ForwardingRuleReference", +"description": "URL of the forwarding rule associated with the health state of the network endpoint." +}, +"healthCheck": { +"$ref": "HealthCheckReference", +"description": "URL of the health check associated with the health state of the network endpoint." +}, +"healthCheckService": { +"$ref": "HealthCheckServiceReference", +"description": "URL of the health check service associated with the health state of the network endpoint." +}, +"healthState": { +"description": "Health state of the network endpoint determined based on the health checks configured.", +"enum": [ +"DRAINING", +"HEALTHY", +"UNHEALTHY", +"UNKNOWN" +], +"enumDescriptions": [ +"Endpoint is being drained.", +"Endpoint is healthy.", +"Endpoint is unhealthy.", +"Health status of the endpoint is unknown." +], +"type": "string" +}, +"ipv6HealthState": { +"description": "Health state of the ipv6 network endpoint determined based on the health checks configured.", +"enum": [ +"DRAINING", +"HEALTHY", +"UNHEALTHY", +"UNKNOWN" +], +"enumDescriptions": [ +"Endpoint is being drained.", +"Endpoint is healthy.", +"Endpoint is unhealthy.", +"Health status of the endpoint is unknown." +], +"type": "string" +} +}, +"type": "object" +}, +"Help": { +"description": "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.", +"id": "Help", +"properties": { +"links": { +"description": "URL(s) pointing to additional information on handling the current error.", +"items": { +"$ref": "HelpLink" +}, +"type": "array" +} +}, +"type": "object" +}, +"HelpLink": { +"description": "Describes a URL link.", +"id": "HelpLink", +"properties": { +"description": { +"description": "Describes what the link offers.", +"type": "string" +}, +"url": { +"description": "The URL of the link.", +"type": "string" +} +}, +"type": "object" +}, +"HostRule": { +"description": "UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.", +"id": "HostRule", +"properties": { +"description": { +"description": "An optional description of this resource. Provide this property when you create the resource.", +"type": "string" +}, +"hosts": { +"description": "The list of host patterns to match. They must be valid hostnames with optional port numbers in the format host:port. * matches any string of ([a-z0-9-.]*). In that case, * must be the first character, and if followed by anything, the immediate following character must be either - or .. * based matching is not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.", +"items": { +"type": "string" +}, +"type": "array" +}, +"pathMatcher": { +"description": "The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.", +"type": "string" +} +}, +"type": "object" +}, +"HttpFaultAbort": { +"description": "Specification for how requests are aborted as part of fault injection.", +"id": "HttpFaultAbort", +"properties": { +"httpStatus": { +"description": "The HTTP status code used to abort the request. The value must be from 200 to 599 inclusive. For gRPC protocol, the gRPC status code is mapped to HTTP status code according to this mapping table. HTTP status 200 is mapped to gRPC status UNKNOWN. Injecting an OK status is currently not supported by Traffic Director.", +"format": "uint32", +"type": "integer" +}, +"percentage": { +"description": "The percentage of traffic for connections, operations, or requests that is aborted as part of fault injection. The value must be from 0.0 to 100.0 inclusive.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"HttpFaultDelay": { +"description": "Specifies the delay introduced by the load balancer before forwarding the request to the backend service as part of fault injection.", +"id": "HttpFaultDelay", +"properties": { +"fixedDelay": { +"$ref": "Duration", +"description": "Specifies the value of the fixed delay interval." +}, +"percentage": { +"description": "The percentage of traffic for connections, operations, or requests for which a delay is introduced as part of fault injection. The value must be from 0.0 to 100.0 inclusive.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"HttpFaultInjection": { +"description": "The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by the load balancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the load balancer for a percentage of requests.", +"id": "HttpFaultInjection", +"properties": { +"abort": { +"$ref": "HttpFaultAbort", +"description": "The specification for how client requests are aborted as part of fault injection." +}, +"delay": { +"$ref": "HttpFaultDelay", +"description": "The specification for how client requests are delayed as part of fault injection, before being sent to a backend service." +} +}, +"type": "object" +}, +"HttpFilterConfig": { +"description": "HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.", +"id": "HttpFilterConfig", +"properties": { +"config": { +"description": "The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl", +"type": "string" +}, +"configTypeUrl": { +"description": "The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct", +"type": "string" +}, +"filterName": { +"description": "Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm", +"type": "string" +} +}, +"type": "object" +}, +"HttpHeaderAction": { +"description": "The request and response header transformations that take effect before the request is passed along to the selected backendService.", +"id": "HttpHeaderAction", +"properties": { +"requestHeadersToAdd": { +"description": "Headers to add to a matching request before forwarding the request to the backendService.", +"items": { +"$ref": "HttpHeaderOption" +}, +"type": "array" +}, +"requestHeadersToRemove": { +"description": "A list of header names for headers that need to be removed from the request before forwarding the request to the backendService.", +"items": { +"type": "string" +}, +"type": "array" +}, +"responseHeadersToAdd": { +"description": "Headers to add the response before sending the response back to the client.", +"items": { +"$ref": "HttpHeaderOption" +}, +"type": "array" +}, +"responseHeadersToRemove": { +"description": "A list of header names for headers that need to be removed from the response before sending the response back to the client.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"HttpHeaderMatch": { +"description": "matchRule criteria for request header matches.", +"id": "HttpHeaderMatch", +"properties": { +"exactMatch": { +"description": "The value should exactly match contents of exactMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.", +"type": "string" +}, +"headerName": { +"description": "The name of the HTTP header to match. For matching against the HTTP request's authority, use a headerMatch with the header name \":authority\". For matching a request's method, use the headerName \":method\". When the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true, only non-binary user-specified custom metadata and the `content-type` header are supported. The following transport-level headers cannot be used in header matching rules: `:authority`, `:method`, `:path`, `:scheme`, `user-agent`, `accept-encoding`, `content-encoding`, `grpc-accept-encoding`, `grpc-encoding`, `grpc-previous-rpc-attempts`, `grpc-tags-bin`, `grpc-timeout` and `grpc-trace-bin`.", +"type": "string" +}, +"invertMatch": { +"description": "If set to false, the headerMatch is considered a match if the preceding match criteria are met. If set to true, the headerMatch is considered a match if the preceding match criteria are NOT met. The default setting is false. ", +"type": "boolean" +}, +"prefixMatch": { +"description": "The value of the header must start with the contents of prefixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.", +"type": "string" +}, +"presentMatch": { +"description": "A header with the contents of headerName must exist. The match takes place whether or not the request's header has a value. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.", +"type": "boolean" +}, +"rangeMatch": { +"$ref": "Int64RangeMatch", +"description": "The header value must be an integer and its value must be in the range specified in rangeMatch. If the header does not contain an integer, number or is empty, the match fails. For example for a range [-5, 0] - -3 will match. - 0 will not match. - 0.25 will not match. - -3someString will not match. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. rangeMatch is not supported for load balancers that have loadBalancingScheme set to EXTERNAL." +}, +"regexMatch": { +"description": "The value of the header must match the regular expression specified in regexMatch. For more information about regular expression syntax, see Syntax. For matching against a port specified in the HTTP request, use a headerMatch with headerName set to PORT and a regular expression that satisfies the RFC2616 Host header's port specifier. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.", +"type": "string" +}, +"suffixMatch": { +"description": "The value of the header must end with the contents of suffixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.", +"type": "string" +} +}, +"type": "object" +}, +"HttpHeaderOption": { +"description": "Specification determining how headers are added to requests or responses.", +"id": "HttpHeaderOption", +"properties": { +"headerName": { +"description": "The name of the header.", +"type": "string" +}, +"headerValue": { +"description": "The value of the header to add.", +"type": "string" +}, +"replace": { +"description": "If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is true, unless a variable is present in headerValue, in which case the default value is false. .", +"type": "boolean" +} +}, +"type": "object" +}, +"HttpHealthCheck": { +"description": "Represents a legacy HTTP Health Check resource. Legacy HTTP health checks are now only required by target pool-based network load balancers. For all other load balancers, including backend service-based network load balancers, and for managed instance group auto-healing, you must use modern (non-legacy) health checks. For more information, see Health checks overview .", +"id": "HttpHealthCheck", +"properties": { +"checkIntervalSec": { +"description": "How often (in seconds) to send a health check. The default value is 5 seconds.", +"format": "int32", +"type": "integer" +}, +"creationTimestamp": { +"description": "[Output Only] Creation timestamp in RFC3339 text format.", +"type": "string" +}, +"description": { +"description": "An optional description of this resource. Provide this property when you create the resource.", +"type": "string" +}, +"healthyThreshold": { +"description": "A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.", +"format": "int32", +"type": "integer" +}, +"host": { +"description": "The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.", +"type": "string" +}, +"id": { +"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", +"format": "uint64", +"type": "string" +}, +"kind": { +"default": "compute#httpHealthCheck", +"description": "[Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.", +"type": "string" +}, +"name": { +"description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"type": "string" +}, +"port": { +"description": "The TCP port number for the HTTP health check request. The default value is 80.", +"format": "int32", +"type": "integer" +}, +"requestPath": { +"description": "The request path of the HTTP health check request. The default value is /. This field does not support query parameters. Must comply with RFC3986.", +"type": "string" +}, +"selfLink": { +"description": "[Output Only] Server-defined URL for the resource.", +"type": "string" +}, +"timeoutSec": { +"description": "How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.", +"format": "int32", +"type": "integer" +}, +"unhealthyThreshold": { +"description": "A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"HttpHealthCheckList": { +"description": "Contains a list of HttpHealthCheck resources.", +"id": "HttpHealthCheckList", +"properties": { +"id": { +"description": "[Output Only] Unique identifier for the resource; defined by the server.", +"type": "string" +}, +"items": { +"description": "A list of HttpHealthCheck resources.", +"items": { +"$ref": "HttpHealthCheck" +}, +"type": "array" +}, +"kind": { +"default": "compute#httpHealthCheckList", "description": "Type of resource.", "type": "string" }, @@ -60050,403 +61656,421 @@ false }, "type": "object" }, -"Image": { -"description": "Represents an Image resource. You can use images to create boot disks for your VM instances. For more information, read Images.", -"id": "Image", +"Image": { +"description": "Represents an Image resource. You can use images to create boot disks for your VM instances. For more information, read Images.", +"id": "Image", +"properties": { +"architecture": { +"description": "The architecture of the image. Valid values are ARM64 or X86_64.", +"enum": [ +"ARCHITECTURE_UNSPECIFIED", +"ARM64", +"X86_64" +], +"enumDescriptions": [ +"Default value indicating Architecture is not set.", +"Machines with architecture ARM64", +"Machines with architecture X86_64" +], +"type": "string" +}, +"archiveSizeBytes": { +"description": "Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).", +"format": "int64", +"type": "string" +}, +"creationTimestamp": { +"description": "[Output Only] Creation timestamp in RFC3339 text format.", +"type": "string" +}, +"deprecated": { +"$ref": "DeprecationStatus", +"description": "The deprecation status associated with this image." +}, +"description": { +"description": "An optional description of this resource. Provide this property when you create the resource.", +"type": "string" +}, +"diskSizeGb": { +"description": "Size of the image when restored onto a persistent disk (in GB).", +"format": "int64", +"type": "string" +}, +"enableConfidentialCompute": { +"description": "Whether this image is created from a confidential compute mode disk. [Output Only]: This field is not set by user, but from source disk.", +"type": "boolean" +}, +"family": { +"description": "The name of the image family to which this image belongs. The image family name can be from a publicly managed image family provided by Compute Engine, or from a custom image family you create. For example, centos-stream-9 is a publicly available image family. For more information, see Image family best practices. When creating disks, you can specify an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035.", +"type": "string" +}, +"guestOsFeatures": { +"description": "A list of features to enable on the guest operating system. Applicable only for bootable images. To see a list of available options, see the guestOSfeatures[].type parameter.", +"items": { +"$ref": "GuestOsFeature" +}, +"type": "array" +}, +"id": { +"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", +"format": "uint64", +"type": "string" +}, +"imageEncryptionKey": { +"$ref": "CustomerEncryptionKey", +"description": "Encrypts the image using a customer-supplied encryption key. After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image). Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later." +}, +"kind": { +"default": "compute#image", +"description": "[Output Only] Type of the resource. Always compute#image for images.", +"type": "string" +}, +"labelFingerprint": { +"description": "A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an image.", +"format": "byte", +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Labels to apply to this image. These can be later modified by the setLabels method.", +"type": "object" +}, +"licenseCodes": { +"description": "Integer license codes indicating which licenses are attached to this image.", +"items": { +"format": "int64", +"type": "string" +}, +"type": "array" +}, +"licenses": { +"description": "Any applicable license URI.", +"items": { +"type": "string" +}, +"type": "array" +}, +"locked": { +"description": "A flag for marketplace VM disk created from the image, which is designed for marketplace VM disk to prevent the proprietary data on the disk from being accessed unwantedly. The flag will be inherited by the disk created from the image. The disk with locked flag set to true will be prohibited from performing the operations below: - R/W or R/O disk attach - Disk detach, if disk is created via create-on-create - Create images - Create snapshots - Create disk clone (create disk from the current disk) The image with the locked field set to true will be prohibited from performing the operations below: - Create images from the current image - Update the locked field for the current image The instance with at least one disk with locked flag set to true will be prohibited from performing the operations below: - Secondary disk attach - Create instant snapshot - Create machine images - Create instance template - Delete the instance with --keep-disk parameter set to true ", +"type": "boolean" +}, +"name": { +"annotations": { +"required": [ +"compute.images.insert" +] +}, +"description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"type": "string" +}, +"params": { +"$ref": "ImageParams", +"description": "Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload." +}, +"rawDisk": { +"description": "The parameters of the raw disk image.", +"properties": { +"containerType": { +"description": "The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.", +"enum": [ +"TAR" +], +"enumDescriptions": [ +"" +], +"type": "string" +}, +"sha1Checksum": { +"deprecated": true, +"description": "[Deprecated] This field is deprecated. An optional SHA1 checksum of the disk image before unpackaging provided by the client when the disk image is created.", +"pattern": "[a-f0-9]{40}", +"type": "string" +}, +"source": { +"description": "The full Google Cloud Storage URL where the raw disk image archive is stored. The following are valid formats for the URL: - https://storage.googleapis.com/bucket_name/image_archive_name - https://storage.googleapis.com/bucket_name/folder_name/ image_archive_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL ", +"type": "string" +} +}, +"type": "object" +}, +"rolloutOverride": { +"$ref": "RolloutPolicy", +"description": "A rollout policy to apply to this image. When specified, the rollout policy overrides per-zone references to the image via the associated image family. The rollout policy restricts the zones where this image is accessible when using a zonal image family reference. When the rollout policy does not include the user specified zone, or if the zone is rolled out, this image is accessible. The rollout policy for this image is read-only, except for allowlisted users. This field might not be configured. To view the latest non-deprecated image in a specific zone, use the imageFamilyViews.get method." +}, +"satisfiesPzi": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "[Output Only] Reserved for future use.", +"type": "boolean" +}, +"selfLink": { +"description": "[Output Only] Server-defined URL for the resource.", +"type": "string" +}, +"shieldedInstanceInitialState": { +"$ref": "InitialStateConfig", +"description": "Set the secure boot keys of shielded instance." +}, +"sourceDisk": { +"description": "URL of the source disk used to create this image. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL ", +"type": "string" +}, +"sourceDiskEncryptionKey": { +"$ref": "CustomerEncryptionKey", +"description": "The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key." +}, +"sourceDiskId": { +"description": "[Output Only] The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.", +"type": "string" +}, +"sourceImage": { +"description": "URL of the source image used to create this image. The following are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/ images/image_name - projects/project_id/global/images/image_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL ", +"type": "string" +}, +"sourceImageEncryptionKey": { +"$ref": "CustomerEncryptionKey", +"description": "The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key." +}, +"sourceImageId": { +"description": "[Output Only] The ID value of the image used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given image name.", +"type": "string" +}, +"sourceSnapshot": { +"description": "URL of the source snapshot used to create this image. The following are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/ snapshots/snapshot_name - projects/project_id/global/snapshots/snapshot_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL ", +"type": "string" +}, +"sourceSnapshotEncryptionKey": { +"$ref": "CustomerEncryptionKey", +"description": "The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key." +}, +"sourceSnapshotId": { +"description": "[Output Only] The ID value of the snapshot used to create this image. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given snapshot name.", +"type": "string" +}, +"sourceType": { +"default": "RAW", +"description": "The type of the image used to create this disk. The default and only valid value is RAW.", +"enum": [ +"RAW" +], +"enumDescriptions": [ +"" +], +"type": "string" +}, +"status": { +"description": "[Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.", +"enum": [ +"DELETING", +"FAILED", +"PENDING", +"READY" +], +"enumDescriptions": [ +"Image is deleting.", +"Image creation failed due to an error.", +"Image hasn't been created as yet.", +"Image has been successfully created." +], +"type": "string" +}, +"storageLocations": { +"description": "Cloud Storage bucket storage location of the image (regional or multi-regional).", +"items": { +"type": "string" +}, +"type": "array" +}, +"userLicenses": { +"description": "A list of publicly visible user-licenses. Unlike regular licenses, user provided licenses can be modified after the disk is created. This includes a list of URLs to the license resource. For example, to provide a debian license: https://www.googleapis.com/compute/v1/projects/debian-cloud/global/licenses/debian-9-stretch ", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ImageFamilyView": { +"id": "ImageFamilyView", +"properties": { +"image": { +"$ref": "Image", +"description": "The latest image that is part of the specified image family in the requested location, and that is not deprecated." +} +}, +"type": "object" +}, +"ImageList": { +"description": "Contains a list of images.", +"id": "ImageList", +"properties": { +"id": { +"description": "[Output Only] Unique identifier for the resource; defined by the server.", +"type": "string" +}, +"items": { +"description": "A list of Image resources.", +"items": { +"$ref": "Image" +}, +"type": "array" +}, +"kind": { +"default": "compute#imageList", +"description": "Type of resource.", +"type": "string" +}, +"nextPageToken": { +"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", +"type": "string" +}, +"selfLink": { +"description": "[Output Only] Server-defined URL for this resource.", +"type": "string" +}, +"warning": { +"description": "[Output Only] Informational warning message.", +"properties": { +"code": { +"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", +"enum": [ +"CLEANUP_FAILED", +"DEPRECATED_RESOURCE_USED", +"DEPRECATED_TYPE_USED", +"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", +"EXPERIMENTAL_TYPE_USED", +"EXTERNAL_API_WARNING", +"FIELD_VALUE_OVERRIDEN", +"INJECTED_KERNELS_DEPRECATED", +"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", +"LARGE_DEPLOYMENT_WARNING", +"LIST_OVERHEAD_QUOTA_EXCEED", +"MISSING_TYPE_DEPENDENCY", +"NEXT_HOP_ADDRESS_NOT_ASSIGNED", +"NEXT_HOP_CANNOT_IP_FORWARD", +"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", +"NEXT_HOP_INSTANCE_NOT_FOUND", +"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", +"NEXT_HOP_NOT_RUNNING", +"NOT_CRITICAL_ERROR", +"NO_RESULTS_ON_PAGE", +"PARTIAL_SUCCESS", +"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 operation.", +"A link to a deprecated resource was created.", +"When deploying and at least one of the resources has a type marked as deprecated", +"The user created a boot disk that is larger than image size.", +"When deploying and at least one of the resources has a type marked as experimental", +"Warning that is present in an external api call", +"Warning that value of a field has been overridden. Deprecated unused field.", +"The operation involved use of an injected kernel, which is deprecated.", +"A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", +"When deploying a deployment with a exceedingly large number of resources", +"Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", +"A resource depends on a missing type", +"The route's nextHopIp address is not assigned to an instance on the network.", +"The route's next hop instance cannot ip forward.", +"The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", +"The route's nextHopInstance URL refers to an instance that does not exist.", +"The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", +"The route's next hop instance does not have a status of RUNNING.", +"Error which is not critical. We decided to continue the process despite the mentioned error.", +"No results are present on a particular list page.", +"Success is reported, but some results may be missing due to errors", +"Quota information is not available to client requests (e.g: regions.list).", +"The user attempted to use a resource that requires a TOS they have not accepted.", +"Warning that a resource is in use.", +"One or more of the resources set to auto-delete could not be deleted because they were in use.", +"When a resource schema validation is ignored.", +"Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", +"When undeclared properties in the schema are present", +"A given scope cannot be reached." +], +"type": "string" +}, +"data": { +"description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", +"type": "string" +}, +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "[Output Only] A human-readable description of the warning code.", +"type": "string" +} +}, +"type": "object" +} +}, +"type": "object" +}, +"ImageParams": { +"description": "Additional image params.", +"id": "ImageParams", "properties": { -"architecture": { -"description": "The architecture of the image. Valid values are ARM64 or X86_64.", -"enum": [ -"ARCHITECTURE_UNSPECIFIED", -"ARM64", -"X86_64" -], -"enumDescriptions": [ -"Default value indicating Architecture is not set.", -"Machines with architecture ARM64", -"Machines with architecture X86_64" -], -"type": "string" -}, -"archiveSizeBytes": { -"description": "Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).", -"format": "int64", -"type": "string" -}, -"creationTimestamp": { -"description": "[Output Only] Creation timestamp in RFC3339 text format.", -"type": "string" -}, -"deprecated": { -"$ref": "DeprecationStatus", -"description": "The deprecation status associated with this image." -}, -"description": { -"description": "An optional description of this resource. Provide this property when you create the resource.", -"type": "string" -}, -"diskSizeGb": { -"description": "Size of the image when restored onto a persistent disk (in GB).", -"format": "int64", -"type": "string" -}, -"enableConfidentialCompute": { -"description": "Whether this image is created from a confidential compute mode disk. [Output Only]: This field is not set by user, but from source disk.", -"type": "boolean" -}, -"family": { -"description": "The name of the image family to which this image belongs. The image family name can be from a publicly managed image family provided by Compute Engine, or from a custom image family you create. For example, centos-stream-9 is a publicly available image family. For more information, see Image family best practices. When creating disks, you can specify an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035.", -"type": "string" -}, -"guestOsFeatures": { -"description": "A list of features to enable on the guest operating system. Applicable only for bootable images. To see a list of available options, see the guestOSfeatures[].type parameter.", -"items": { -"$ref": "GuestOsFeature" -}, -"type": "array" -}, -"id": { -"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", -"format": "uint64", -"type": "string" -}, -"imageEncryptionKey": { -"$ref": "CustomerEncryptionKey", -"description": "Encrypts the image using a customer-supplied encryption key. After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image). Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later." -}, -"kind": { -"default": "compute#image", -"description": "[Output Only] Type of the resource. Always compute#image for images.", -"type": "string" -}, -"labelFingerprint": { -"description": "A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an image.", -"format": "byte", -"type": "string" -}, -"labels": { +"resourceManagerTags": { "additionalProperties": { "type": "string" }, -"description": "Labels to apply to this image. These can be later modified by the setLabels method.", -"type": "object" -}, -"licenseCodes": { -"description": "Integer license codes indicating which licenses are attached to this image.", -"items": { -"format": "int64", -"type": "string" -}, -"type": "array" -}, -"licenses": { -"description": "Any applicable license URI.", -"items": { -"type": "string" -}, -"type": "array" -}, -"locked": { -"description": "A flag for marketplace VM disk created from the image, which is designed for marketplace VM disk to prevent the proprietary data on the disk from being accessed unwantedly. The flag will be inherited by the disk created from the image. The disk with locked flag set to true will be prohibited from performing the operations below: - R/W or R/O disk attach - Disk detach, if disk is created via create-on-create - Create images - Create snapshots - Create disk clone (create disk from the current disk) The image with the locked field set to true will be prohibited from performing the operations below: - Create images from the current image - Update the locked field for the current image The instance with at least one disk with locked flag set to true will be prohibited from performing the operations below: - Secondary disk attach - Create instant snapshot - Create machine images - Create instance template - Delete the instance with --keep-disk parameter set to true ", -"type": "boolean" -}, -"name": { -"annotations": { -"required": [ -"compute.images.insert" -] -}, -"description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", -"type": "string" -}, -"rawDisk": { -"description": "The parameters of the raw disk image.", -"properties": { -"containerType": { -"description": "The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.", -"enum": [ -"TAR" -], -"enumDescriptions": [ -"" -], -"type": "string" -}, -"sha1Checksum": { -"deprecated": true, -"description": "[Deprecated] This field is deprecated. An optional SHA1 checksum of the disk image before unpackaging provided by the client when the disk image is created.", -"pattern": "[a-f0-9]{40}", -"type": "string" -}, -"source": { -"description": "The full Google Cloud Storage URL where the raw disk image archive is stored. The following are valid formats for the URL: - https://storage.googleapis.com/bucket_name/image_archive_name - https://storage.googleapis.com/bucket_name/folder_name/ image_archive_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL ", -"type": "string" -} -}, -"type": "object" -}, -"rolloutOverride": { -"$ref": "RolloutPolicy", -"description": "A rollout policy to apply to this image. When specified, the rollout policy overrides per-zone references to the image via the associated image family. The rollout policy restricts the zones where this image is accessible when using a zonal image family reference. When the rollout policy does not include the user specified zone, or if the zone is rolled out, this image is accessible. The rollout policy for this image is read-only, except for allowlisted users. This field might not be configured. To view the latest non-deprecated image in a specific zone, use the imageFamilyViews.get method." -}, -"satisfiesPzi": { -"description": "Output only. Reserved for future use.", -"readOnly": true, -"type": "boolean" -}, -"satisfiesPzs": { -"description": "[Output Only] Reserved for future use.", -"type": "boolean" -}, -"selfLink": { -"description": "[Output Only] Server-defined URL for the resource.", -"type": "string" -}, -"shieldedInstanceInitialState": { -"$ref": "InitialStateConfig", -"description": "Set the secure boot keys of shielded instance." -}, -"sourceDisk": { -"description": "URL of the source disk used to create this image. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL ", -"type": "string" -}, -"sourceDiskEncryptionKey": { -"$ref": "CustomerEncryptionKey", -"description": "The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key." -}, -"sourceDiskId": { -"description": "[Output Only] The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.", -"type": "string" -}, -"sourceImage": { -"description": "URL of the source image used to create this image. The following are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/ images/image_name - projects/project_id/global/images/image_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL ", -"type": "string" -}, -"sourceImageEncryptionKey": { -"$ref": "CustomerEncryptionKey", -"description": "The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key." -}, -"sourceImageId": { -"description": "[Output Only] The ID value of the image used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given image name.", -"type": "string" -}, -"sourceSnapshot": { -"description": "URL of the source snapshot used to create this image. The following are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/ snapshots/snapshot_name - projects/project_id/global/snapshots/snapshot_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL ", -"type": "string" -}, -"sourceSnapshotEncryptionKey": { -"$ref": "CustomerEncryptionKey", -"description": "The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key." -}, -"sourceSnapshotId": { -"description": "[Output Only] The ID value of the snapshot used to create this image. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given snapshot name.", -"type": "string" -}, -"sourceType": { -"default": "RAW", -"description": "The type of the image used to create this disk. The default and only valid value is RAW.", -"enum": [ -"RAW" -], -"enumDescriptions": [ -"" -], -"type": "string" -}, -"status": { -"description": "[Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.", -"enum": [ -"DELETING", -"FAILED", -"PENDING", -"READY" -], -"enumDescriptions": [ -"Image is deleting.", -"Image creation failed due to an error.", -"Image hasn't been created as yet.", -"Image has been successfully created." -], -"type": "string" -}, -"storageLocations": { -"description": "Cloud Storage bucket storage location of the image (regional or multi-regional).", -"items": { -"type": "string" -}, -"type": "array" -}, -"userLicenses": { -"description": "A list of publicly visible user-licenses. Unlike regular licenses, user provided licenses can be modified after the disk is created. This includes a list of URLs to the license resource. For example, to provide a debian license: https://www.googleapis.com/compute/v1/projects/debian-cloud/global/licenses/debian-9-stretch ", -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, -"ImageFamilyView": { -"id": "ImageFamilyView", -"properties": { -"image": { -"$ref": "Image", -"description": "The latest image that is part of the specified image family in the requested location, and that is not deprecated." -} -}, -"type": "object" -}, -"ImageList": { -"description": "Contains a list of images.", -"id": "ImageList", -"properties": { -"id": { -"description": "[Output Only] Unique identifier for the resource; defined by the server.", -"type": "string" -}, -"items": { -"description": "A list of Image resources.", -"items": { -"$ref": "Image" -}, -"type": "array" -}, -"kind": { -"default": "compute#imageList", -"description": "Type of resource.", -"type": "string" -}, -"nextPageToken": { -"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", -"type": "string" -}, -"selfLink": { -"description": "[Output Only] Server-defined URL for this resource.", -"type": "string" -}, -"warning": { -"description": "[Output Only] Informational warning message.", -"properties": { -"code": { -"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", -"enum": [ -"CLEANUP_FAILED", -"DEPRECATED_RESOURCE_USED", -"DEPRECATED_TYPE_USED", -"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", -"EXPERIMENTAL_TYPE_USED", -"EXTERNAL_API_WARNING", -"FIELD_VALUE_OVERRIDEN", -"INJECTED_KERNELS_DEPRECATED", -"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", -"LARGE_DEPLOYMENT_WARNING", -"LIST_OVERHEAD_QUOTA_EXCEED", -"MISSING_TYPE_DEPENDENCY", -"NEXT_HOP_ADDRESS_NOT_ASSIGNED", -"NEXT_HOP_CANNOT_IP_FORWARD", -"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", -"NEXT_HOP_INSTANCE_NOT_FOUND", -"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", -"NEXT_HOP_NOT_RUNNING", -"NOT_CRITICAL_ERROR", -"NO_RESULTS_ON_PAGE", -"PARTIAL_SUCCESS", -"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 operation.", -"A link to a deprecated resource was created.", -"When deploying and at least one of the resources has a type marked as deprecated", -"The user created a boot disk that is larger than image size.", -"When deploying and at least one of the resources has a type marked as experimental", -"Warning that is present in an external api call", -"Warning that value of a field has been overridden. Deprecated unused field.", -"The operation involved use of an injected kernel, which is deprecated.", -"A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", -"When deploying a deployment with a exceedingly large number of resources", -"Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", -"A resource depends on a missing type", -"The route's nextHopIp address is not assigned to an instance on the network.", -"The route's next hop instance cannot ip forward.", -"The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", -"The route's nextHopInstance URL refers to an instance that does not exist.", -"The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", -"The route's next hop instance does not have a status of RUNNING.", -"Error which is not critical. We decided to continue the process despite the mentioned error.", -"No results are present on a particular list page.", -"Success is reported, but some results may be missing due to errors", -"Quota information is not available to client requests (e.g: regions.list).", -"The user attempted to use a resource that requires a TOS they have not accepted.", -"Warning that a resource is in use.", -"One or more of the resources set to auto-delete could not be deleted because they were in use.", -"When a resource schema validation is ignored.", -"Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", -"When undeclared properties in the schema are present", -"A given scope cannot be reached." -], -"type": "string" -}, -"data": { -"description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", -"items": { -"properties": { -"key": { -"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", -"type": "string" -}, -"value": { -"description": "[Output Only] A warning data value corresponding to the key.", -"type": "string" -} -}, -"type": "object" -}, -"type": "array" -}, -"message": { -"description": "[Output Only] A human-readable description of the warning code.", -"type": "string" -} -}, +"description": "Resource manager tags to be bound to the image. 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.", "type": "object" } }, @@ -66228,6 +67852,18 @@ false ], "type": "string" }, +"subzone": { +"description": "Specific subzone in the InterconnectLocation that represents where this connection is to be provisioned.", +"enum": [ +"SUBZONE_A", +"SUBZONE_B" +], +"enumDescriptions": [ +"Subzone A.", +"Subzone B." +], +"type": "string" +}, "wireGroups": { "description": "[Output Only] A list of the URLs of all CrossSiteNetwork WireGroups configured to use this Interconnect. The Interconnect cannot be deleted if this list is non-empty.", "items": { @@ -71371,55 +73007,502 @@ false "description": "[Output Only] Indicates the field in the request that caused the error. This property is optional.", "type": "string" }, -"message": { -"description": "[Output Only] An optional, human-readable error message.", +"message": { +"description": "[Output Only] An optional, human-readable error message.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +} +}, +"type": "object" +}, +"timestamp": { +"description": "[Output Only] Timestamp is shown only if there is an error. The field has // RFC3339 // text format.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"MultiMigsList": { +"id": "MultiMigsList", +"properties": { +"id": { +"description": "Unique identifier for the resource; defined by the server.", +"type": "string" +}, +"items": { +"description": "A list of multi-MIGs in the specified project and region.", +"items": { +"$ref": "MultiMig" +}, +"type": "array" +}, +"kind": { +"default": "compute#multiMigList", +"description": "Type of resource.", +"type": "string" +}, +"nextPageToken": { +"description": "This token allows you to get the next page of results for maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", +"type": "string" +}, +"selfLink": { +"description": "[Output only] Server-defined URL for this resource.", +"type": "string" +}, +"warning": { +"description": "Informational warning message.", +"properties": { +"code": { +"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", +"enum": [ +"CLEANUP_FAILED", +"DEPRECATED_RESOURCE_USED", +"DEPRECATED_TYPE_USED", +"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", +"EXPERIMENTAL_TYPE_USED", +"EXTERNAL_API_WARNING", +"FIELD_VALUE_OVERRIDEN", +"INJECTED_KERNELS_DEPRECATED", +"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", +"LARGE_DEPLOYMENT_WARNING", +"LIST_OVERHEAD_QUOTA_EXCEED", +"MISSING_TYPE_DEPENDENCY", +"NEXT_HOP_ADDRESS_NOT_ASSIGNED", +"NEXT_HOP_CANNOT_IP_FORWARD", +"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", +"NEXT_HOP_INSTANCE_NOT_FOUND", +"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", +"NEXT_HOP_NOT_RUNNING", +"NOT_CRITICAL_ERROR", +"NO_RESULTS_ON_PAGE", +"PARTIAL_SUCCESS", +"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 operation.", +"A link to a deprecated resource was created.", +"When deploying and at least one of the resources has a type marked as deprecated", +"The user created a boot disk that is larger than image size.", +"When deploying and at least one of the resources has a type marked as experimental", +"Warning that is present in an external api call", +"Warning that value of a field has been overridden. Deprecated unused field.", +"The operation involved use of an injected kernel, which is deprecated.", +"A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", +"When deploying a deployment with a exceedingly large number of resources", +"Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", +"A resource depends on a missing type", +"The route's nextHopIp address is not assigned to an instance on the network.", +"The route's next hop instance cannot ip forward.", +"The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", +"The route's nextHopInstance URL refers to an instance that does not exist.", +"The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", +"The route's next hop instance does not have a status of RUNNING.", +"Error which is not critical. We decided to continue the process despite the mentioned error.", +"No results are present on a particular list page.", +"Success is reported, but some results may be missing due to errors", +"Quota information is not available to client requests (e.g: regions.list).", +"The user attempted to use a resource that requires a TOS they have not accepted.", +"Warning that a resource is in use.", +"One or more of the resources set to auto-delete could not be deleted because they were in use.", +"When a resource schema validation is ignored.", +"Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", +"When undeclared properties in the schema are present", +"A given scope cannot be reached." +], +"type": "string" +}, +"data": { +"description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", +"type": "string" +}, +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "[Output Only] A human-readable description of the warning code.", +"type": "string" +} +}, +"type": "object" +} +}, +"type": "object" +}, +"NamedPort": { +"description": "The named port. For example: <\"http\", 80>.", +"id": "NamedPort", +"properties": { +"name": { +"description": "The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.", +"type": "string" +}, +"port": { +"description": "The port number, which can be a value between 1 and 65535.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"NatIpInfo": { +"description": "Contains NAT IP information of a NAT config (i.e. usage status, mode).", +"id": "NatIpInfo", +"properties": { +"natIpInfoMappings": { +"description": "A list of all NAT IPs assigned to this NAT config.", +"items": { +"$ref": "NatIpInfoNatIpInfoMapping" +}, +"type": "array" +}, +"natName": { +"description": "Name of the NAT config which the NAT IP belongs to.", +"type": "string" +} +}, +"type": "object" +}, +"NatIpInfoNatIpInfoMapping": { +"description": "Contains information of a NAT IP.", +"id": "NatIpInfoNatIpInfoMapping", +"properties": { +"mode": { +"description": "Specifies whether NAT IP is auto or manual.", +"enum": [ +"AUTO", +"MANUAL" +], +"enumDescriptions": [ +"", +"" +], +"type": "string" +}, +"natIp": { +"description": "NAT IP address. For example: 203.0.113.11.", +"type": "string" +}, +"usage": { +"description": "Specifies whether NAT IP is currently serving at least one endpoint or not.", +"enum": [ +"IN_USE", +"UNUSED" +], +"enumDescriptions": [ +"", +"" +], +"type": "string" +} +}, +"type": "object" +}, +"NatIpInfoResponse": { +"id": "NatIpInfoResponse", +"properties": { +"result": { +"description": "[Output Only] A list of NAT IP information.", +"items": { +"$ref": "NatIpInfo" +}, +"type": "array" +} +}, +"type": "object" +}, +"Network": { +"description": "Represents a VPC Network resource. Networks connect resources to each other and to the internet. For more information, read Virtual Private Cloud (VPC) Network.", +"id": "Network", +"properties": { +"IPv4Range": { +"deprecated": true, +"description": "Deprecated in favor of subnet mode networks. The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.", +"pattern": "[0-9]{1,3}(?:\\.[0-9]{1,3}){3}/[0-9]{1,2}", +"type": "string" +}, +"autoCreateSubnetworks": { +"description": "Must be set to create a VPC network. If not set, a legacy network is created. When set to true, the VPC network is created in auto mode. When set to false, the VPC network is created in custom mode. An auto mode VPC network starts with one subnet per region. Each subnet has a predetermined range as described in Auto mode VPC network IP ranges. For custom mode VPC networks, you can add subnets using the subnetworks insert method.", +"type": "boolean" +}, +"creationTimestamp": { +"description": "[Output Only] Creation timestamp in RFC3339 text format.", +"type": "string" +}, +"description": { +"description": "An optional description of this resource. Provide this field when you create the resource.", +"type": "string" +}, +"enableUlaInternalIpv6": { +"description": "Enable ULA internal ipv6 on this network. Enabling this feature will assign a /48 from google defined ULA prefix fd20::/20. .", +"type": "boolean" +}, +"firewallPolicy": { +"description": "[Output Only] URL of the firewall policy the network is associated with.", +"type": "string" +}, +"gatewayIPv4": { +"description": "[Output Only] The gateway address for default routing out of the network, selected by Google Cloud.", +"pattern": "[0-9]{1,3}(?:\\.[0-9]{1,3}){3}", +"type": "string" +}, +"id": { +"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", +"format": "uint64", +"type": "string" +}, +"internalIpv6Range": { +"description": "When enabling ula internal ipv6, caller optionally can specify the /48 range they want from the google defined ULA prefix fd20::/20. The input must be a valid /48 ULA IPv6 address and must be within the fd20::/20. Operation will fail if the speficied /48 is already in used by another resource. If the field is not speficied, then a /48 range will be randomly allocated from fd20::/20 and returned via this field. .", +"type": "string" +}, +"kind": { +"default": "compute#network", +"description": "[Output Only] Type of the resource. Always compute#network for networks.", +"type": "string" +}, +"mtu": { +"description": "Maximum Transmission Unit in bytes. The minimum value for this field is 1300 and the maximum value is 8896. The suggested value is 1500, which is the default MTU used on the Internet, or 8896 if you want to use Jumbo frames. If unspecified, the value defaults to 1460.", +"format": "int32", +"type": "integer" +}, +"name": { +"annotations": { +"required": [ +"compute.networks.insert" +] +}, +"description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"type": "string" +}, +"networkFirewallPolicyEnforcementOrder": { +"description": "The network firewall policy enforcement order. Can be either AFTER_CLASSIC_FIREWALL or BEFORE_CLASSIC_FIREWALL. Defaults to AFTER_CLASSIC_FIREWALL if the field is not specified.", +"enum": [ +"AFTER_CLASSIC_FIREWALL", +"BEFORE_CLASSIC_FIREWALL" +], +"enumDescriptions": [ +"", +"" +], +"type": "string" +}, +"networkProfile": { +"description": "A full or partial URL of the network profile to apply to this network. This field can be set only at resource creation time. For example, the following are valid URLs: - https://www.googleapis.com/compute/{api_version}/projects/{project_id}/global/networkProfiles/{network_profile_name} - projects/{project_id}/global/networkProfiles/{network_profile_name} ", +"type": "string" +}, +"params": { +"$ref": "NetworkParams", +"description": "Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload." +}, +"peerings": { +"description": "[Output Only] A list of network peerings for the resource.", +"items": { +"$ref": "NetworkPeering" +}, +"type": "array" +}, +"routingConfig": { +"$ref": "NetworkRoutingConfig", +"description": "The network-level routing configuration for this network. Used by Cloud Router to determine what type of network-wide routing behavior to enforce." +}, +"selfLink": { +"description": "[Output Only] Server-defined URL for the resource.", +"type": "string" +}, +"selfLinkWithId": { +"description": "[Output Only] Server-defined URL for this resource with the resource id.", +"type": "string" +}, +"subnetworks": { +"description": "[Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"NetworkAttachment": { +"description": "NetworkAttachments A network attachment resource ...", +"id": "NetworkAttachment", +"properties": { +"connectionEndpoints": { +"description": "[Output Only] An array of connections for all the producers connected to this network attachment.", +"items": { +"$ref": "NetworkAttachmentConnectedEndpoint" +}, +"type": "array" +}, +"connectionPreference": { +"enum": [ +"ACCEPT_AUTOMATIC", +"ACCEPT_MANUAL", +"INVALID" +], +"enumDescriptions": [ +"", +"", +"" +], +"type": "string" +}, +"creationTimestamp": { +"description": "[Output Only] Creation timestamp in RFC3339 text format.", +"type": "string" +}, +"description": { +"description": "An optional description of this resource. Provide this property when you create the resource.", +"type": "string" +}, +"fingerprint": { +"description": "Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. An up-to-date fingerprint must be provided in order to patch.", +"format": "byte", +"type": "string" +}, +"id": { +"description": "[Output Only] The unique identifier for the resource type. The server generates this identifier.", +"format": "uint64", +"type": "string" +}, +"kind": { +"default": "compute#networkAttachment", +"description": "[Output Only] Type of the resource.", +"type": "string" +}, +"name": { +"annotations": { +"required": [ +"compute.networkAttachments.insert" +] +}, +"description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"type": "string" +}, +"network": { +"description": "[Output Only] The URL of the network which the Network Attachment belongs to. Practically it is inferred by fetching the network of the first subnetwork associated. Because it is required that all the subnetworks must be from the same network, it is assured that the Network Attachment belongs to the same network as all the subnetworks.", +"type": "string" +}, +"producerAcceptLists": { +"description": "Projects that are allowed to connect to this network attachment. The project can be specified using its id or number.", +"items": { +"type": "string" +}, +"type": "array" +}, +"producerRejectLists": { +"description": "Projects that are not allowed to connect to this network attachment. The project can be specified using its id or number.", +"items": { +"type": "string" +}, +"type": "array" +}, +"region": { +"description": "[Output Only] URL of the region where the network attachment resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", +"type": "string" +}, +"selfLink": { +"description": "[Output Only] Server-defined URL for the resource.", +"type": "string" +}, +"selfLinkWithId": { +"description": "[Output Only] Server-defined URL for this resource's resource id.", +"type": "string" +}, +"subnetworks": { +"description": "An array of URLs where each entry is the URL of a subnet provided by the service consumer to use for endpoints in the producers that connect to this network attachment.", +"items": { "type": "string" -} -}, -"type": "object" }, "type": "array" } }, "type": "object" }, -"timestamp": { -"description": "[Output Only] Timestamp is shown only if there is an error. The field has // RFC3339 // text format.", -"format": "google-datetime", -"type": "string" -} -}, -"type": "object" -}, -"MultiMigsList": { -"id": "MultiMigsList", +"NetworkAttachmentAggregatedList": { +"description": "Contains a list of NetworkAttachmentsScopedList.", +"id": "NetworkAttachmentAggregatedList", "properties": { "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 multi-MIGs in the specified project and region.", -"items": { -"$ref": "MultiMig" +"additionalProperties": { +"$ref": "NetworkAttachmentsScopedList", +"description": "Name of the scope containing this set of NetworkAttachments." }, -"type": "array" +"description": "A list of NetworkAttachmentsScopedList resources.", +"type": "object" }, "kind": { -"default": "compute#multiMigList", -"description": "Type of resource.", +"default": "compute#networkAttachmentAggregatedList", "type": "string" }, "nextPageToken": { -"description": "This token allows you to get the next page of results for maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", +"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { -"description": "[Output only] Server-defined URL for this resource.", +"description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { -"description": "Informational warning message.", +"description": "[Output Only] Informational warning message.", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", @@ -71545,225 +73628,354 @@ false }, "type": "object" }, -"NamedPort": { -"description": "The named port. For example: <\"http\", 80>.", -"id": "NamedPort", +"NetworkAttachmentConnectedEndpoint": { +"description": "[Output Only] A connection connected to this network attachment.", +"id": "NetworkAttachmentConnectedEndpoint", "properties": { -"name": { -"description": "The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.", +"ipAddress": { +"description": "The IPv4 address assigned to the producer instance network interface. This value will be a range in case of Serverless.", "type": "string" }, -"port": { -"description": "The port number, which can be a value between 1 and 65535.", -"format": "int32", -"type": "integer" -} +"ipv6Address": { +"description": "The IPv6 address assigned to the producer instance network interface. This is only assigned when the stack types of both the instance network interface and the consumer subnet are IPv4_IPv6.", +"type": "string" }, -"type": "object" +"projectIdOrNum": { +"description": "The project id or number of the interface to which the IP was assigned.", +"type": "string" }, -"NatIpInfo": { -"description": "Contains NAT IP information of a NAT config (i.e. usage status, mode).", -"id": "NatIpInfo", -"properties": { -"natIpInfoMappings": { -"description": "A list of all NAT IPs assigned to this NAT config.", +"secondaryIpCidrRanges": { +"description": "Alias IP ranges from the same subnetwork.", "items": { -"$ref": "NatIpInfoNatIpInfoMapping" -}, -"type": "array" -}, -"natName": { -"description": "Name of the NAT config which the NAT IP belongs to.", "type": "string" -} }, -"type": "object" +"type": "array" }, -"NatIpInfoNatIpInfoMapping": { -"description": "Contains information of a NAT IP.", -"id": "NatIpInfoNatIpInfoMapping", -"properties": { -"mode": { -"description": "Specifies whether NAT IP is auto or manual.", +"status": { +"description": "The status of a connected endpoint to this network attachment.", "enum": [ -"AUTO", -"MANUAL" +"ACCEPTED", +"CLOSED", +"NEEDS_ATTENTION", +"PENDING", +"REJECTED", +"STATUS_UNSPECIFIED" ], "enumDescriptions": [ -"", +"The consumer allows traffic from the producer to reach its VPC.", +"The consumer network attachment no longer exists.", +"The consumer needs to take further action before traffic can be served.", +"The consumer neither allows nor prohibits traffic from the producer to reach its VPC.", +"The consumer prohibits traffic from the producer to reach its VPC.", "" ], "type": "string" }, -"natIp": { -"description": "NAT IP address. For example: 203.0.113.11.", +"subnetwork": { +"description": "The subnetwork used to assign the IP to the producer instance network interface.", "type": "string" }, -"usage": { -"description": "Specifies whether NAT IP is currently serving at least one endpoint or not.", -"enum": [ -"IN_USE", -"UNUSED" -], -"enumDescriptions": [ -"", -"" -], +"subnetworkCidrRange": { +"description": "[Output Only] The CIDR range of the subnet from which the IPv4 internal IP was allocated from.", "type": "string" } }, "type": "object" }, -"NatIpInfoResponse": { -"id": "NatIpInfoResponse", +"NetworkAttachmentList": { +"id": "NetworkAttachmentList", "properties": { -"result": { -"description": "[Output Only] A list of NAT IP information.", +"id": { +"description": "[Output Only] Unique identifier for the resource; defined by the server.", +"type": "string" +}, "items": { -"$ref": "NatIpInfo" +"description": "A list of NetworkAttachment resources.", +"items": { +"$ref": "NetworkAttachment" }, "type": "array" -} -}, -"type": "object" }, -"Network": { -"description": "Represents a VPC Network resource. Networks connect resources to each other and to the internet. For more information, read Virtual Private Cloud (VPC) Network.", -"id": "Network", -"properties": { -"IPv4Range": { -"deprecated": true, -"description": "Deprecated in favor of subnet mode networks. The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.", -"pattern": "[0-9]{1,3}(?:\\.[0-9]{1,3}){3}/[0-9]{1,2}", +"kind": { +"default": "compute#networkAttachmentList", "type": "string" }, -"autoCreateSubnetworks": { -"description": "Must be set to create a VPC network. If not set, a legacy network is created. When set to true, the VPC network is created in auto mode. When set to false, the VPC network is created in custom mode. An auto mode VPC network starts with one subnet per region. Each subnet has a predetermined range as described in Auto mode VPC network IP ranges. For custom mode VPC networks, you can add subnets using the subnetworks insert method.", -"type": "boolean" -}, -"creationTimestamp": { -"description": "[Output Only] Creation timestamp in RFC3339 text format.", +"nextPageToken": { +"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, -"description": { -"description": "An optional description of this resource. Provide this field when you create the resource.", +"selfLink": { +"description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, -"enableUlaInternalIpv6": { -"description": "Enable ULA internal ipv6 on this network. Enabling this feature will assign a /48 from google defined ULA prefix fd20::/20. .", -"type": "boolean" -}, -"firewallPolicy": { -"description": "[Output Only] URL of the firewall policy the network is associated with.", +"warning": { +"description": "[Output Only] Informational warning message.", +"properties": { +"code": { +"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", +"enum": [ +"CLEANUP_FAILED", +"DEPRECATED_RESOURCE_USED", +"DEPRECATED_TYPE_USED", +"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", +"EXPERIMENTAL_TYPE_USED", +"EXTERNAL_API_WARNING", +"FIELD_VALUE_OVERRIDEN", +"INJECTED_KERNELS_DEPRECATED", +"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", +"LARGE_DEPLOYMENT_WARNING", +"LIST_OVERHEAD_QUOTA_EXCEED", +"MISSING_TYPE_DEPENDENCY", +"NEXT_HOP_ADDRESS_NOT_ASSIGNED", +"NEXT_HOP_CANNOT_IP_FORWARD", +"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", +"NEXT_HOP_INSTANCE_NOT_FOUND", +"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", +"NEXT_HOP_NOT_RUNNING", +"NOT_CRITICAL_ERROR", +"NO_RESULTS_ON_PAGE", +"PARTIAL_SUCCESS", +"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 operation.", +"A link to a deprecated resource was created.", +"When deploying and at least one of the resources has a type marked as deprecated", +"The user created a boot disk that is larger than image size.", +"When deploying and at least one of the resources has a type marked as experimental", +"Warning that is present in an external api call", +"Warning that value of a field has been overridden. Deprecated unused field.", +"The operation involved use of an injected kernel, which is deprecated.", +"A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", +"When deploying a deployment with a exceedingly large number of resources", +"Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", +"A resource depends on a missing type", +"The route's nextHopIp address is not assigned to an instance on the network.", +"The route's next hop instance cannot ip forward.", +"The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", +"The route's nextHopInstance URL refers to an instance that does not exist.", +"The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", +"The route's next hop instance does not have a status of RUNNING.", +"Error which is not critical. We decided to continue the process despite the mentioned error.", +"No results are present on a particular list page.", +"Success is reported, but some results may be missing due to errors", +"Quota information is not available to client requests (e.g: regions.list).", +"The user attempted to use a resource that requires a TOS they have not accepted.", +"Warning that a resource is in use.", +"One or more of the resources set to auto-delete could not be deleted because they were in use.", +"When a resource schema validation is ignored.", +"Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", +"When undeclared properties in the schema are present", +"A given scope cannot be reached." +], "type": "string" }, -"gatewayIPv4": { -"description": "[Output Only] The gateway address for default routing out of the network, selected by Google Cloud.", -"pattern": "[0-9]{1,3}(?:\\.[0-9]{1,3}){3}", +"data": { +"description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, -"id": { -"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", -"format": "uint64", +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", "type": "string" +} }, -"internalIpv6Range": { -"description": "When enabling ula internal ipv6, caller optionally can specify the /48 range they want from the google defined ULA prefix fd20::/20. The input must be a valid /48 ULA IPv6 address and must be within the fd20::/20. Operation will fail if the speficied /48 is already in used by another resource. If the field is not speficied, then a /48 range will be randomly allocated from fd20::/20 and returned via this field. .", -"type": "string" +"type": "object" }, -"kind": { -"default": "compute#network", -"description": "[Output Only] Type of the resource. Always compute#network for networks.", +"type": "array" +}, +"message": { +"description": "[Output Only] A human-readable description of the warning code.", "type": "string" +} }, -"mtu": { -"description": "Maximum Transmission Unit in bytes. The minimum value for this field is 1300 and the maximum value is 8896. The suggested value is 1500, which is the default MTU used on the Internet, or 8896 if you want to use Jumbo frames. If unspecified, the value defaults to 1460.", -"format": "int32", -"type": "integer" +"type": "object" +} }, -"name": { -"annotations": { -"required": [ -"compute.networks.insert" -] +"type": "object" }, -"description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", -"type": "string" +"NetworkAttachmentsScopedList": { +"id": "NetworkAttachmentsScopedList", +"properties": { +"networkAttachments": { +"description": "A list of NetworkAttachments contained in this scope.", +"items": { +"$ref": "NetworkAttachment" }, -"networkFirewallPolicyEnforcementOrder": { -"description": "The network firewall policy enforcement order. Can be either AFTER_CLASSIC_FIREWALL or BEFORE_CLASSIC_FIREWALL. Defaults to AFTER_CLASSIC_FIREWALL if the field is not specified.", +"type": "array" +}, +"warning": { +"description": "Informational warning which replaces the list of network attachments when the list is empty.", +"properties": { +"code": { +"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "enum": [ -"AFTER_CLASSIC_FIREWALL", -"BEFORE_CLASSIC_FIREWALL" +"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 operation.", +"A link to a deprecated resource was created.", +"When deploying and at least one of the resources has a type marked as deprecated", +"The user created a boot disk that is larger than image size.", +"When deploying and at least one of the resources has a type marked as experimental", +"Warning that is present in an external api call", +"Warning that value of a field has been overridden. Deprecated unused field.", +"The operation involved use of an injected kernel, which is deprecated.", +"A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", +"When deploying a deployment with a exceedingly large number of resources", +"Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", +"A resource depends on a missing type", +"The route's nextHopIp address is not assigned to an instance on the network.", +"The route's next hop instance cannot ip forward.", +"The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", +"The route's nextHopInstance URL refers to an instance that does not exist.", +"The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", +"The route's next hop instance does not have a status of RUNNING.", +"Error which is not critical. We decided to continue the process despite the mentioned error.", +"No results are present on a particular list page.", +"Success is reported, but some results may be missing due to errors", +"Quota information is not available to client requests (e.g: regions.list).", +"The user attempted to use a resource that requires a TOS they have not accepted.", +"Warning that a resource is in use.", +"One or more of the resources set to auto-delete could not be deleted because they were in use.", +"When a resource schema validation is ignored.", +"Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", +"When undeclared properties in the schema are present", +"A given scope cannot be reached." ], "type": "string" }, -"networkProfile": { -"description": "A full or partial URL of the network profile to apply to this network. This field can be set only at resource creation time. For example, the following are valid URLs: - https://www.googleapis.com/compute/{api_version}/projects/{project_id}/global/networkProfiles/{network_profile_name} - projects/{project_id}/global/networkProfiles/{network_profile_name} ", +"data": { +"description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, -"params": { -"$ref": "NetworkParams", -"description": "Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload." +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", +"type": "string" +} }, -"peerings": { -"description": "[Output Only] A list of network peerings for the resource.", -"items": { -"$ref": "NetworkPeering" +"type": "object" }, "type": "array" }, -"routingConfig": { -"$ref": "NetworkRoutingConfig", -"description": "The network-level routing configuration for this network. Used by Cloud Router to determine what type of network-wide routing behavior to enforce." -}, -"selfLink": { -"description": "[Output Only] Server-defined URL for the resource.", -"type": "string" -}, -"selfLinkWithId": { -"description": "[Output Only] Server-defined URL for this resource with the resource id.", -"type": "string" -}, -"subnetworks": { -"description": "[Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network.", -"items": { +"message": { +"description": "[Output Only] A human-readable description of the warning code.", "type": "string" +} }, -"type": "array" +"type": "object" } }, "type": "object" }, -"NetworkAttachment": { -"description": "NetworkAttachments A network attachment resource ...", -"id": "NetworkAttachment", +"NetworkEdgeSecurityService": { +"description": "Represents a Google Cloud Armor network edge security service resource.", +"id": "NetworkEdgeSecurityService", "properties": { -"connectionEndpoints": { -"description": "[Output Only] An array of connections for all the producers connected to this network attachment.", -"items": { -"$ref": "NetworkAttachmentConnectedEndpoint" -}, -"type": "array" -}, -"connectionPreference": { -"enum": [ -"ACCEPT_AUTOMATIC", -"ACCEPT_MANUAL", -"INVALID" -], -"enumDescriptions": [ -"", -"", -"" -], -"type": "string" -}, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" @@ -71773,50 +73985,31 @@ false "type": "string" }, "fingerprint": { -"description": "Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. An up-to-date fingerprint must be provided in order to patch.", +"description": "Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a NetworkEdgeSecurityService. An up-to-date fingerprint must be provided in order to update the NetworkEdgeSecurityService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a NetworkEdgeSecurityService.", "format": "byte", "type": "string" }, "id": { -"description": "[Output Only] The unique identifier for the resource type. The server generates this identifier.", +"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "format": "uint64", "type": "string" }, "kind": { -"default": "compute#networkAttachment", -"description": "[Output Only] Type of the resource.", -"type": "string" -}, -"name": { -"annotations": { -"required": [ -"compute.networkAttachments.insert" -] -}, -"description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", -"type": "string" -}, -"network": { -"description": "[Output Only] The URL of the network which the Network Attachment belongs to. Practically it is inferred by fetching the network of the first subnetwork associated. Because it is required that all the subnetworks must be from the same network, it is assured that the Network Attachment belongs to the same network as all the subnetworks.", -"type": "string" -}, -"producerAcceptLists": { -"description": "Projects that are allowed to connect to this network attachment. The project can be specified using its id or number.", -"items": { -"type": "string" -}, -"type": "array" -}, -"producerRejectLists": { -"description": "Projects that are not allowed to connect to this network attachment. The project can be specified using its id or number.", -"items": { +"default": "compute#networkEdgeSecurityService", +"description": "[Output only] Type of the resource. Always compute#networkEdgeSecurityService for NetworkEdgeSecurityServices", "type": "string" }, -"type": "array" +"name": { +"description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"type": "string" }, "region": { -"description": "[Output Only] URL of the region where the network attachment resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", +"description": "[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.", +"type": "string" +}, +"securityPolicy": { +"description": "The resource URL for the network edge security service associated with this network edge security service.", "type": "string" }, "selfLink": { @@ -71824,37 +74017,33 @@ false "type": "string" }, "selfLinkWithId": { -"description": "[Output Only] Server-defined URL for this resource's resource id.", -"type": "string" -}, -"subnetworks": { -"description": "An array of URLs where each entry is the URL of a subnet provided by the service consumer to use for endpoints in the producers that connect to this network attachment.", -"items": { +"description": "[Output Only] Server-defined URL for this resource with the resource id.", "type": "string" -}, -"type": "array" } }, "type": "object" }, -"NetworkAttachmentAggregatedList": { -"description": "Contains a list of NetworkAttachmentsScopedList.", -"id": "NetworkAttachmentAggregatedList", +"NetworkEdgeSecurityServiceAggregatedList": { +"id": "NetworkEdgeSecurityServiceAggregatedList", "properties": { +"etag": { +"type": "string" +}, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "additionalProperties": { -"$ref": "NetworkAttachmentsScopedList", -"description": "Name of the scope containing this set of NetworkAttachments." +"$ref": "NetworkEdgeSecurityServicesScopedList", +"description": "Name of the scope containing this set of security policies." }, -"description": "A list of NetworkAttachmentsScopedList resources.", +"description": "A list of NetworkEdgeSecurityServicesScopedList resources.", "type": "object" }, "kind": { -"default": "compute#networkAttachmentAggregatedList", +"default": "compute#networkEdgeSecurityServiceAggregatedList", +"description": "[Output Only] Type of resource. Always compute#networkEdgeSecurityServiceAggregatedList for lists of Network Edge Security Services.", "type": "string" }, "nextPageToken": { @@ -71865,6 +74054,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": { @@ -71992,88 +74188,18 @@ false }, "type": "object" }, -"NetworkAttachmentConnectedEndpoint": { -"description": "[Output Only] A connection connected to this network attachment.", -"id": "NetworkAttachmentConnectedEndpoint", -"properties": { -"ipAddress": { -"description": "The IPv4 address assigned to the producer instance network interface. This value will be a range in case of Serverless.", -"type": "string" -}, -"ipv6Address": { -"description": "The IPv6 address assigned to the producer instance network interface. This is only assigned when the stack types of both the instance network interface and the consumer subnet are IPv4_IPv6.", -"type": "string" -}, -"projectIdOrNum": { -"description": "The project id or number of the interface to which the IP was assigned.", -"type": "string" -}, -"secondaryIpCidrRanges": { -"description": "Alias IP ranges from the same subnetwork.", -"items": { -"type": "string" -}, -"type": "array" -}, -"status": { -"description": "The status of a connected endpoint to this network attachment.", -"enum": [ -"ACCEPTED", -"CLOSED", -"NEEDS_ATTENTION", -"PENDING", -"REJECTED", -"STATUS_UNSPECIFIED" -], -"enumDescriptions": [ -"The consumer allows traffic from the producer to reach its VPC.", -"The consumer network attachment no longer exists.", -"The consumer needs to take further action before traffic can be served.", -"The consumer neither allows nor prohibits traffic from the producer to reach its VPC.", -"The consumer prohibits traffic from the producer to reach its VPC.", -"" -], -"type": "string" -}, -"subnetwork": { -"description": "The subnetwork used to assign the IP to the producer instance network interface.", -"type": "string" -}, -"subnetworkCidrRange": { -"description": "[Output Only] The CIDR range of the subnet from which the IPv4 internal IP was allocated from.", -"type": "string" -} -}, -"type": "object" -}, -"NetworkAttachmentList": { -"id": "NetworkAttachmentList", +"NetworkEdgeSecurityServicesScopedList": { +"id": "NetworkEdgeSecurityServicesScopedList", "properties": { -"id": { -"description": "[Output Only] Unique identifier for the resource; defined by the server.", -"type": "string" -}, -"items": { -"description": "A list of NetworkAttachment resources.", +"networkEdgeSecurityServices": { +"description": "A list of NetworkEdgeSecurityServices contained in this scope.", "items": { -"$ref": "NetworkAttachment" +"$ref": "NetworkEdgeSecurityService" }, "type": "array" }, -"kind": { -"default": "compute#networkAttachmentList", -"type": "string" -}, -"nextPageToken": { -"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", -"type": "string" -}, -"selfLink": { -"description": "[Output Only] Server-defined URL for this resource.", -"type": "string" -}, "warning": { -"description": "[Output Only] Informational warning message.", +"description": "Informational warning which replaces the list of security policies when the list is empty.", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", @@ -72199,18 +74325,202 @@ false }, "type": "object" }, -"NetworkAttachmentsScopedList": { -"id": "NetworkAttachmentsScopedList", +"NetworkEndpoint": { +"description": "The network endpoint.", +"id": "NetworkEndpoint", "properties": { -"networkAttachments": { -"description": "A list of NetworkAttachments contained in this scope.", +"annotations": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional metadata defined as annotations on the network endpoint.", +"type": "object" +}, +"clientDestinationPort": { +"description": "Represents the port number to which PSC consumer sends packets. Optional. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type.", +"format": "int32", +"type": "integer" +}, +"fqdn": { +"description": "Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT.", +"type": "string" +}, +"instance": { +"description": "The name or a URL of VM instance of this network endpoint. Optional, the field presence depends on the network endpoint type. The field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance.", +"type": "string" +}, +"ipAddress": { +"description": "Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork.", +"type": "string" +}, +"ipv6Address": { +"description": "Optional IPv6 address of network endpoint.", +"type": "string" +}, +"port": { +"description": "Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"NetworkEndpointGroup": { +"description": "Represents a collection of network endpoints. A network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs for different use cases, see Network endpoint groups overview.", +"id": "NetworkEndpointGroup", +"properties": { +"annotations": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Metadata defined as annotations on the network endpoint group.", +"type": "object" +}, +"appEngine": { +"$ref": "NetworkEndpointGroupAppEngine", +"description": "Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set." +}, +"cloudFunction": { +"$ref": "NetworkEndpointGroupCloudFunction", +"description": "Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set." +}, +"cloudRun": { +"$ref": "NetworkEndpointGroupCloudRun", +"description": "Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set." +}, +"creationTimestamp": { +"description": "[Output Only] Creation timestamp in RFC3339 text format.", +"type": "string" +}, +"defaultPort": { +"description": "The default port used if the port number is not specified in the network endpoint. Optional. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified.", +"format": "int32", +"type": "integer" +}, +"description": { +"description": "An optional description of this resource. Provide this property when you create the resource.", +"type": "string" +}, +"id": { +"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", +"format": "uint64", +"type": "string" +}, +"kind": { +"default": "compute#networkEndpointGroup", +"description": "[Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group.", +"type": "string" +}, +"loadBalancer": { +"$ref": "NetworkEndpointGroupLbNetworkEndpointGroup", +"deprecated": true, +"description": "This field is only valid when the network endpoint group is used for load balancing. [Deprecated] This field is deprecated." +}, +"name": { +"description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", +"type": "string" +}, +"network": { +"description": "The URL of the network to which all network endpoints in the NEG belong. Uses default project network if unspecified.", +"type": "string" +}, +"networkEndpointType": { +"description": "Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT, GCE_VM_IP_PORTMAP.", +"enum": [ +"GCE_VM_IP", +"GCE_VM_IP_PORT", +"GCE_VM_IP_PORTMAP", +"INTERNET_FQDN_PORT", +"INTERNET_IP_PORT", +"NON_GCP_PRIVATE_IP_PORT", +"PRIVATE_SERVICE_CONNECT", +"SERVERLESS" +], +"enumDescriptions": [ +"The network endpoint is represented by an IP address.", +"The network endpoint is represented by IP address and port pair.", +"The network endpoint is represented by an IP, Port and Client Destination Port.", +"The network endpoint is represented by fully qualified domain name and port.", +"The network endpoint is represented by an internet IP address and port.", +"The network endpoint is represented by an IP address and port. The endpoint belongs to a VM or pod running in a customer's on-premises.", +"The network endpoint is either public Google APIs or services exposed by other GCP Project with a Service Attachment. The connection is set up by private service connect", +"The network endpoint is handled by specified serverless infrastructure." +], +"type": "string" +}, +"pscData": { +"$ref": "NetworkEndpointGroupPscData", +"description": "Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT." +}, +"pscTargetService": { +"description": "The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com. Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT.", +"type": "string" +}, +"region": { +"description": "[Output Only] The URL of the region where the network endpoint group is located.", +"type": "string" +}, +"selfLink": { +"description": "[Output Only] Server-defined URL for the resource.", +"type": "string" +}, +"serverlessDeployment": { +"$ref": "NetworkEndpointGroupServerlessDeployment", +"description": "Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine, cloudFunction or serverlessDeployment may be set." +}, +"size": { +"description": "[Output only] Number of network endpoints in the network endpoint group.", +"format": "int32", +"type": "integer" +}, +"subnetwork": { +"description": "Optional URL of the subnetwork to which all network endpoints in the NEG belong.", +"type": "string" +}, +"zone": { +"description": "[Output Only] The URL of the zone where the network endpoint group is located.", +"type": "string" +} +}, +"type": "object" +}, +"NetworkEndpointGroupAggregatedList": { +"id": "NetworkEndpointGroupAggregatedList", +"properties": { +"id": { +"description": "[Output Only] Unique identifier for the resource; defined by the server.", +"type": "string" +}, "items": { -"$ref": "NetworkAttachment" +"additionalProperties": { +"$ref": "NetworkEndpointGroupsScopedList", +"description": "The name of the scope that contains this set of network endpoint groups." +}, +"description": "A list of NetworkEndpointGroupsScopedList resources.", +"type": "object" +}, +"kind": { +"default": "compute#networkEndpointGroupAggregatedList", +"description": "[Output Only] The resource type, which is always compute#networkEndpointGroupAggregatedList for aggregated lists of network endpoint groups.", +"type": "string" +}, +"nextPageToken": { +"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", +"type": "string" +}, +"selfLink": { +"description": "[Output Only] Server-defined URL for this resource.", +"type": "string" +}, +"unreachables": { +"description": "[Output Only] Unreachable resources.", +"items": { +"type": "string" }, "type": "array" }, "warning": { -"description": "Informational warning which replaces the list of network attachments when the list is empty.", +"description": "[Output Only] Informational warning message.", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", @@ -72336,78 +74646,104 @@ false }, "type": "object" }, -"NetworkEdgeSecurityService": { -"description": "Represents a Google Cloud Armor network edge security service resource.", -"id": "NetworkEdgeSecurityService", +"NetworkEndpointGroupAppEngine": { +"description": "Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG.", +"id": "NetworkEndpointGroupAppEngine", "properties": { -"creationTimestamp": { -"description": "[Output Only] Creation timestamp in RFC3339 text format.", +"service": { +"description": "Optional serving service. The service name is case-sensitive and must be 1-63 characters long. Example value: default, my-service.", "type": "string" }, -"description": { -"description": "An optional description of this resource. Provide this property when you create the resource.", +"urlMask": { +"description": "An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask -dot-appname.appspot.com/. The URL mask will parse them to { service = \"foo1\", version = \"v1\" } and { service = \"foo1\", version = \"v2\" } respectively.", "type": "string" }, -"fingerprint": { -"description": "Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a NetworkEdgeSecurityService. An up-to-date fingerprint must be provided in order to update the NetworkEdgeSecurityService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a NetworkEdgeSecurityService.", -"format": "byte", +"version": { +"description": "Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2.", "type": "string" +} }, -"id": { -"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", -"format": "uint64", -"type": "string" +"type": "object" }, -"kind": { -"default": "compute#networkEdgeSecurityService", -"description": "[Output only] Type of the resource. Always compute#networkEdgeSecurityService for NetworkEdgeSecurityServices", +"NetworkEndpointGroupCloudFunction": { +"description": "Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG.", +"id": "NetworkEndpointGroupCloudFunction", +"properties": { +"function": { +"description": "A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1.", "type": "string" }, -"name": { -"description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"urlMask": { +"description": "An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /. The URL mask will parse them to { function = \"function1\" } and { function = \"function2\" } respectively.", "type": "string" +} }, -"region": { -"description": "[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.", -"type": "string" +"type": "object" }, -"securityPolicy": { -"description": "The resource URL for the network edge security service associated with this network edge security service.", +"NetworkEndpointGroupCloudRun": { +"description": "Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG.", +"id": "NetworkEndpointGroupCloudRun", +"properties": { +"service": { +"description": "Cloud Run service is the main resource of Cloud Run. The service must be 1-63 characters long, and comply with RFC1035. Example value: \"run-service\".", "type": "string" }, -"selfLink": { -"description": "[Output Only] Server-defined URL for the resource.", +"tag": { +"description": "Optional Cloud Run tag represents the \"named-revision\" to provide additional fine-grained traffic routing information. The tag must be 1-63 characters long, and comply with RFC1035. Example value: \"revision-0010\".", "type": "string" }, -"selfLinkWithId": { -"description": "[Output Only] Server-defined URL for this resource with the resource id.", +"urlMask": { +"description": "An URL mask is one of the main components of the Cloud Function. A template to parse and fields from a request URL. URL mask allows for routing to multiple Run services without having to create multiple network endpoint groups and backend services. For example, request URLs foo1.domain.com/bar1 and foo1.domain.com/bar2 can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask .domain.com/. The URL mask will parse them to { service=\"bar1\", tag=\"foo1\" } and { service=\"bar2\", tag=\"foo2\" } respectively.", "type": "string" } }, "type": "object" }, -"NetworkEdgeSecurityServiceAggregatedList": { -"id": "NetworkEdgeSecurityServiceAggregatedList", +"NetworkEndpointGroupLbNetworkEndpointGroup": { +"description": "Load balancing specific fields for network endpoint group.", +"id": "NetworkEndpointGroupLbNetworkEndpointGroup", "properties": { -"etag": { +"defaultPort": { +"deprecated": true, +"description": "The default port used if the port number is not specified in the network endpoint. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. [Deprecated] This field is deprecated.", +"format": "int32", +"type": "integer" +}, +"network": { +"deprecated": true, +"description": "The URL of the network to which all network endpoints in the NEG belong. Uses default project network if unspecified. [Deprecated] This field is deprecated.", +"type": "string" +}, +"subnetwork": { +"deprecated": true, +"description": "Optional URL of the subnetwork to which all network endpoints in the NEG belong. [Deprecated] This field is deprecated.", +"type": "string" +}, +"zone": { +"deprecated": true, +"description": "[Output Only] The URL of the zone where the network endpoint group is located. [Deprecated] This field is deprecated.", "type": "string" +} }, +"type": "object" +}, +"NetworkEndpointGroupList": { +"id": "NetworkEndpointGroupList", +"properties": { "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { -"additionalProperties": { -"$ref": "NetworkEdgeSecurityServicesScopedList", -"description": "Name of the scope containing this set of security policies." +"description": "A list of NetworkEndpointGroup resources.", +"items": { +"$ref": "NetworkEndpointGroup" }, -"description": "A list of NetworkEdgeSecurityServicesScopedList resources.", -"type": "object" +"type": "array" }, "kind": { -"default": "compute#networkEdgeSecurityServiceAggregatedList", -"description": "[Output Only] Type of resource. Always compute#networkEdgeSecurityServiceAggregatedList for lists of Network Edge Security Services.", +"default": "compute#networkEndpointGroupList", +"description": "[Output Only] The resource type, which is always compute#networkEndpointGroupList for network endpoint group lists.", "type": "string" }, "nextPageToken": { @@ -72418,13 +74754,6 @@ 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": { @@ -72525,45 +74854,182 @@ false ], "type": "string" }, -"data": { -"description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", -"items": { -"properties": { -"key": { -"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", +"data": { +"description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", +"type": "string" +}, +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "[Output Only] A human-readable description of the warning code.", +"type": "string" +} +}, +"type": "object" +} +}, +"type": "object" +}, +"NetworkEndpointGroupPscData": { +"description": "All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT.", +"id": "NetworkEndpointGroupPscData", +"properties": { +"consumerPscAddress": { +"description": "[Output Only] Address allocated from given subnetwork for PSC. This IP address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in L7 PSC-XLB.", +"type": "string" +}, +"producerPort": { +"description": "The psc producer port is used to connect PSC NEG with specific port on the PSC Producer side; should only be used for the PRIVATE_SERVICE_CONNECT NEG type", +"format": "int32", +"type": "integer" +}, +"pscConnectionId": { +"description": "[Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer.", +"format": "uint64", +"type": "string" +}, +"pscConnectionStatus": { +"description": "[Output Only] The connection status of the PSC Forwarding Rule.", +"enum": [ +"ACCEPTED", +"CLOSED", +"NEEDS_ATTENTION", +"PENDING", +"REJECTED", +"STATUS_UNSPECIFIED" +], +"enumDescriptions": [ +"The connection has been accepted by the producer.", +"The connection has been closed by the producer and will not serve traffic going forward.", +"The connection has been accepted by the producer, but the producer needs to take further action before the forwarding rule can serve traffic.", +"The connection is pending acceptance by the producer.", +"The connection has been rejected by the producer.", +"" +], +"type": "string" +} +}, +"type": "object" +}, +"NetworkEndpointGroupServerlessDeployment": { +"description": "Configuration for a serverless network endpoint group (NEG). The platform must be provided. Note: The target backend service must be in the same project and located in the same region as the Serverless NEG.", +"id": "NetworkEndpointGroupServerlessDeployment", +"properties": { +"platform": { +"description": "The platform of the backend target(s) of this NEG. The only supported value is API Gateway: apigateway.googleapis.com.", +"type": "string" +}, +"resource": { +"description": "The user-defined name of the workload/instance. This value must be provided explicitly or in the urlMask. The resource identified by this value is platform-specific and is as follows: 1. API Gateway: The gateway ID 2. App Engine: The service name 3. Cloud Functions: The function name 4. Cloud Run: The service name ", +"type": "string" +}, +"urlMask": { +"description": "An URL mask is one of the main components of the Cloud Function. A template to parse platform-specific fields from a request URL. URL mask allows for routing to multiple resources on the same serverless platform without having to create multiple Network Endpoint Groups and backend resources. The fields parsed by this template are platform-specific and are as follows: 1. API Gateway: The gateway ID 2. App Engine: The service and version 3. Cloud Functions: The function name 4. Cloud Run: The service and tag ", "type": "string" }, -"value": { -"description": "[Output Only] A warning data value corresponding to the key.", +"version": { +"description": "The optional resource version. The version identified by this value is platform-specific and is follows: 1. API Gateway: Unused 2. App Engine: The service version 3. Cloud Functions: Unused 4. Cloud Run: The service tag ", "type": "string" } }, "type": "object" }, +"NetworkEndpointGroupsAttachEndpointsRequest": { +"id": "NetworkEndpointGroupsAttachEndpointsRequest", +"properties": { +"networkEndpoints": { +"description": "The list of network endpoints to be attached.", +"items": { +"$ref": "NetworkEndpoint" +}, "type": "array" +} }, -"message": { -"description": "[Output Only] A human-readable description of the warning code.", +"type": "object" +}, +"NetworkEndpointGroupsDetachEndpointsRequest": { +"id": "NetworkEndpointGroupsDetachEndpointsRequest", +"properties": { +"networkEndpoints": { +"description": "The list of network endpoints to be detached.", +"items": { +"$ref": "NetworkEndpoint" +}, +"type": "array" +} +}, +"type": "object" +}, +"NetworkEndpointGroupsListEndpointsRequest": { +"id": "NetworkEndpointGroupsListEndpointsRequest", +"properties": { +"endpointFilters": { +"description": "Optional list of endpoints to query. This is a more efficient but also limited version of filter parameter. Endpoints in the filter must have ip_address and port fields populated, other fields are not supported.", +"items": { +"$ref": "NetworkEndpointGroupsListEndpointsRequestNetworkEndpointFilter" +}, +"type": "array" +}, +"healthStatus": { +"description": "Optional query parameter for showing the health status of each network endpoint. Valid options are SKIP or SHOW. If you don't specify this parameter, the health status of network endpoints will not be provided.", +"enum": [ +"SHOW", +"SKIP" +], +"enumDescriptions": [ +"Show the health status for each network endpoint. Impacts latency of the call.", +"Health status for network endpoints will not be provided." +], "type": "string" } }, "type": "object" +}, +"NetworkEndpointGroupsListEndpointsRequestNetworkEndpointFilter": { +"id": "NetworkEndpointGroupsListEndpointsRequestNetworkEndpointFilter", +"properties": { +"networkEndpoint": { +"$ref": "NetworkEndpoint" } }, "type": "object" }, -"NetworkEdgeSecurityServicesScopedList": { -"id": "NetworkEdgeSecurityServicesScopedList", +"NetworkEndpointGroupsListNetworkEndpoints": { +"id": "NetworkEndpointGroupsListNetworkEndpoints", "properties": { -"networkEdgeSecurityServices": { -"description": "A list of NetworkEdgeSecurityServices contained in this scope.", +"id": { +"description": "[Output Only] Unique identifier for the resource; defined by the server.", +"type": "string" +}, "items": { -"$ref": "NetworkEdgeSecurityService" +"description": "A list of NetworkEndpointWithHealthStatus resources.", +"items": { +"$ref": "NetworkEndpointWithHealthStatus" }, "type": "array" }, +"kind": { +"default": "compute#networkEndpointGroupsListNetworkEndpoints", +"description": "[Output Only] The resource type, which is always compute#networkEndpointGroupsListNetworkEndpoints for the list of network endpoints in the specified network endpoint group.", +"type": "string" +}, +"nextPageToken": { +"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", +"type": "string" +}, "warning": { -"description": "Informational warning which replaces the list of security policies when the list is empty.", +"description": "[Output Only] Informational warning message.", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", @@ -72689,202 +75155,18 @@ false }, "type": "object" }, -"NetworkEndpoint": { -"description": "The network endpoint.", -"id": "NetworkEndpoint", -"properties": { -"annotations": { -"additionalProperties": { -"type": "string" -}, -"description": "Optional metadata defined as annotations on the network endpoint.", -"type": "object" -}, -"clientDestinationPort": { -"description": "Represents the port number to which PSC consumer sends packets. Optional. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type.", -"format": "int32", -"type": "integer" -}, -"fqdn": { -"description": "Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT.", -"type": "string" -}, -"instance": { -"description": "The name or a URL of VM instance of this network endpoint. Optional, the field presence depends on the network endpoint type. The field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance.", -"type": "string" -}, -"ipAddress": { -"description": "Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork.", -"type": "string" -}, -"ipv6Address": { -"description": "Optional IPv6 address of network endpoint.", -"type": "string" -}, -"port": { -"description": "Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP.", -"format": "int32", -"type": "integer" -} -}, -"type": "object" -}, -"NetworkEndpointGroup": { -"description": "Represents a collection of network endpoints. A network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs for different use cases, see Network endpoint groups overview.", -"id": "NetworkEndpointGroup", -"properties": { -"annotations": { -"additionalProperties": { -"type": "string" -}, -"description": "Optional. Metadata defined as annotations on the network endpoint group.", -"type": "object" -}, -"appEngine": { -"$ref": "NetworkEndpointGroupAppEngine", -"description": "Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set." -}, -"cloudFunction": { -"$ref": "NetworkEndpointGroupCloudFunction", -"description": "Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set." -}, -"cloudRun": { -"$ref": "NetworkEndpointGroupCloudRun", -"description": "Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set." -}, -"creationTimestamp": { -"description": "[Output Only] Creation timestamp in RFC3339 text format.", -"type": "string" -}, -"defaultPort": { -"description": "The default port used if the port number is not specified in the network endpoint. Optional. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified.", -"format": "int32", -"type": "integer" -}, -"description": { -"description": "An optional description of this resource. Provide this property when you create the resource.", -"type": "string" -}, -"id": { -"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", -"format": "uint64", -"type": "string" -}, -"kind": { -"default": "compute#networkEndpointGroup", -"description": "[Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group.", -"type": "string" -}, -"loadBalancer": { -"$ref": "NetworkEndpointGroupLbNetworkEndpointGroup", -"deprecated": true, -"description": "This field is only valid when the network endpoint group is used for load balancing. [Deprecated] This field is deprecated." -}, -"name": { -"description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", -"type": "string" -}, -"network": { -"description": "The URL of the network to which all network endpoints in the NEG belong. Uses default project network if unspecified.", -"type": "string" -}, -"networkEndpointType": { -"description": "Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT, GCE_VM_IP_PORTMAP.", -"enum": [ -"GCE_VM_IP", -"GCE_VM_IP_PORT", -"GCE_VM_IP_PORTMAP", -"INTERNET_FQDN_PORT", -"INTERNET_IP_PORT", -"NON_GCP_PRIVATE_IP_PORT", -"PRIVATE_SERVICE_CONNECT", -"SERVERLESS" -], -"enumDescriptions": [ -"The network endpoint is represented by an IP address.", -"The network endpoint is represented by IP address and port pair.", -"The network endpoint is represented by an IP, Port and Client Destination Port.", -"The network endpoint is represented by fully qualified domain name and port.", -"The network endpoint is represented by an internet IP address and port.", -"The network endpoint is represented by an IP address and port. The endpoint belongs to a VM or pod running in a customer's on-premises.", -"The network endpoint is either public Google APIs or services exposed by other GCP Project with a Service Attachment. The connection is set up by private service connect", -"The network endpoint is handled by specified serverless infrastructure." -], -"type": "string" -}, -"pscData": { -"$ref": "NetworkEndpointGroupPscData", -"description": "Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT." -}, -"pscTargetService": { -"description": "The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com. Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT.", -"type": "string" -}, -"region": { -"description": "[Output Only] The URL of the region where the network endpoint group is located.", -"type": "string" -}, -"selfLink": { -"description": "[Output Only] Server-defined URL for the resource.", -"type": "string" -}, -"serverlessDeployment": { -"$ref": "NetworkEndpointGroupServerlessDeployment", -"description": "Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine, cloudFunction or serverlessDeployment may be set." -}, -"size": { -"description": "[Output only] Number of network endpoints in the network endpoint group.", -"format": "int32", -"type": "integer" -}, -"subnetwork": { -"description": "Optional URL of the subnetwork to which all network endpoints in the NEG belong.", -"type": "string" -}, -"zone": { -"description": "[Output Only] The URL of the zone where the network endpoint group is located.", -"type": "string" -} -}, -"type": "object" -}, -"NetworkEndpointGroupAggregatedList": { -"id": "NetworkEndpointGroupAggregatedList", +"NetworkEndpointGroupsScopedList": { +"id": "NetworkEndpointGroupsScopedList", "properties": { -"id": { -"description": "[Output Only] Unique identifier for the resource; defined by the server.", -"type": "string" -}, -"items": { -"additionalProperties": { -"$ref": "NetworkEndpointGroupsScopedList", -"description": "The name of the scope that contains this set of network endpoint groups." -}, -"description": "A list of NetworkEndpointGroupsScopedList resources.", -"type": "object" -}, -"kind": { -"default": "compute#networkEndpointGroupAggregatedList", -"description": "[Output Only] The resource type, which is always compute#networkEndpointGroupAggregatedList for aggregated lists of network endpoint groups.", -"type": "string" -}, -"nextPageToken": { -"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", -"type": "string" -}, -"selfLink": { -"description": "[Output Only] Server-defined URL for this resource.", -"type": "string" -}, -"unreachables": { -"description": "[Output Only] Unreachable resources.", +"networkEndpointGroups": { +"description": "[Output Only] The list of network endpoint groups that are contained in this scope.", "items": { -"type": "string" +"$ref": "NetworkEndpointGroup" }, "type": "array" }, "warning": { -"description": "[Output Only] Informational warning message.", +"description": "[Output Only] An informational warning that replaces the list of network endpoint groups when the list is empty.", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", @@ -73010,104 +75292,41 @@ false }, "type": "object" }, -"NetworkEndpointGroupAppEngine": { -"description": "Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG.", -"id": "NetworkEndpointGroupAppEngine", -"properties": { -"service": { -"description": "Optional serving service. The service name is case-sensitive and must be 1-63 characters long. Example value: default, my-service.", -"type": "string" -}, -"urlMask": { -"description": "An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask -dot-appname.appspot.com/. The URL mask will parse them to { service = \"foo1\", version = \"v1\" } and { service = \"foo1\", version = \"v2\" } respectively.", -"type": "string" -}, -"version": { -"description": "Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2.", -"type": "string" -} -}, -"type": "object" -}, -"NetworkEndpointGroupCloudFunction": { -"description": "Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG.", -"id": "NetworkEndpointGroupCloudFunction", -"properties": { -"function": { -"description": "A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1.", -"type": "string" -}, -"urlMask": { -"description": "An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /. The URL mask will parse them to { function = \"function1\" } and { function = \"function2\" } respectively.", -"type": "string" -} -}, -"type": "object" -}, -"NetworkEndpointGroupCloudRun": { -"description": "Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG.", -"id": "NetworkEndpointGroupCloudRun", -"properties": { -"service": { -"description": "Cloud Run service is the main resource of Cloud Run. The service must be 1-63 characters long, and comply with RFC1035. Example value: \"run-service\".", -"type": "string" -}, -"tag": { -"description": "Optional Cloud Run tag represents the \"named-revision\" to provide additional fine-grained traffic routing information. The tag must be 1-63 characters long, and comply with RFC1035. Example value: \"revision-0010\".", -"type": "string" -}, -"urlMask": { -"description": "An URL mask is one of the main components of the Cloud Function. A template to parse and fields from a request URL. URL mask allows for routing to multiple Run services without having to create multiple network endpoint groups and backend services. For example, request URLs foo1.domain.com/bar1 and foo1.domain.com/bar2 can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask .domain.com/. The URL mask will parse them to { service=\"bar1\", tag=\"foo1\" } and { service=\"bar2\", tag=\"foo2\" } respectively.", -"type": "string" -} -}, -"type": "object" -}, -"NetworkEndpointGroupLbNetworkEndpointGroup": { -"description": "Load balancing specific fields for network endpoint group.", -"id": "NetworkEndpointGroupLbNetworkEndpointGroup", +"NetworkEndpointWithHealthStatus": { +"id": "NetworkEndpointWithHealthStatus", "properties": { -"defaultPort": { -"deprecated": true, -"description": "The default port used if the port number is not specified in the network endpoint. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified. [Deprecated] This field is deprecated.", -"format": "int32", -"type": "integer" -}, -"network": { -"deprecated": true, -"description": "The URL of the network to which all network endpoints in the NEG belong. Uses default project network if unspecified. [Deprecated] This field is deprecated.", -"type": "string" +"healths": { +"description": "[Output only] The health status of network endpoint. Optional. Displayed only if the network endpoint has centralized health checking configured.", +"items": { +"$ref": "HealthStatusForNetworkEndpoint" }, -"subnetwork": { -"deprecated": true, -"description": "Optional URL of the subnetwork to which all network endpoints in the NEG belong. [Deprecated] This field is deprecated.", -"type": "string" +"type": "array" }, -"zone": { -"deprecated": true, -"description": "[Output Only] The URL of the zone where the network endpoint group is located. [Deprecated] This field is deprecated.", -"type": "string" +"networkEndpoint": { +"$ref": "NetworkEndpoint", +"description": "[Output only] The network endpoint." } }, "type": "object" }, -"NetworkEndpointGroupList": { -"id": "NetworkEndpointGroupList", +"NetworkFirewallPolicyAggregatedList": { +"id": "NetworkFirewallPolicyAggregatedList", "properties": { "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { -"description": "A list of NetworkEndpointGroup resources.", -"items": { -"$ref": "NetworkEndpointGroup" +"additionalProperties": { +"$ref": "FirewallPoliciesScopedList", +"description": "Name of the scope containing this set of addresses." }, -"type": "array" +"description": "A list of FirewallPoliciesScopedList resources.", +"type": "object" }, "kind": { -"default": "compute#networkEndpointGroupList", -"description": "[Output Only] The resource type, which is always compute#networkEndpointGroupList for network endpoint group lists.", +"default": "compute#networkFirewallPolicyAggregatedList", +"description": "[Output Only] Type of resource. Always compute#networkFirewallPoliciesAggregatedList for lists of network firewall policies.", "type": "string" }, "nextPageToken": { @@ -73118,6 +75337,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": { @@ -73245,153 +75471,173 @@ false }, "type": "object" }, -"NetworkEndpointGroupPscData": { -"description": "All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT.", -"id": "NetworkEndpointGroupPscData", +"NetworkInterface": { +"description": "A network interface resource attached to an instance.", +"id": "NetworkInterface", "properties": { -"consumerPscAddress": { -"description": "[Output Only] Address allocated from given subnetwork for PSC. This IP address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in L7 PSC-XLB.", -"type": "string" +"accessConfigs": { +"description": "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.", +"items": { +"$ref": "AccessConfig" }, -"producerPort": { -"description": "The psc producer port is used to connect PSC NEG with specific port on the PSC Producer side; should only be used for the PRIVATE_SERVICE_CONNECT NEG type", -"format": "int32", -"type": "integer" +"type": "array" }, -"pscConnectionId": { -"description": "[Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer.", -"format": "uint64", +"aliasIpRanges": { +"description": "An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.", +"items": { +"$ref": "AliasIpRange" +}, +"type": "array" +}, +"fingerprint": { +"description": "Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.", +"format": "byte", "type": "string" }, -"pscConnectionStatus": { -"description": "[Output Only] The connection status of the PSC Forwarding Rule.", +"igmpQuery": { +"description": "Indicate whether igmp query is enabled on the network interface or not. If enabled, also indicates the version of IGMP supported.", "enum": [ -"ACCEPTED", -"CLOSED", -"NEEDS_ATTENTION", -"PENDING", -"REJECTED", -"STATUS_UNSPECIFIED" +"IGMP_QUERY_DISABLED", +"IGMP_QUERY_V2" ], "enumDescriptions": [ -"The connection has been accepted by the producer.", -"The connection has been closed by the producer and will not serve traffic going forward.", -"The connection has been accepted by the producer, but the producer needs to take further action before the forwarding rule can serve traffic.", -"The connection is pending acceptance by the producer.", -"The connection has been rejected by the producer.", -"" +"The network interface has disabled IGMP query.", +"The network interface has enabled IGMP query - v2." ], "type": "string" -} }, -"type": "object" +"internalIpv6PrefixLength": { +"description": "The prefix length of the primary internal IPv6 range.", +"format": "int32", +"type": "integer" }, -"NetworkEndpointGroupServerlessDeployment": { -"description": "Configuration for a serverless network endpoint group (NEG). The platform must be provided. Note: The target backend service must be in the same project and located in the same region as the Serverless NEG.", -"id": "NetworkEndpointGroupServerlessDeployment", -"properties": { -"platform": { -"description": "The platform of the backend target(s) of this NEG. The only supported value is API Gateway: apigateway.googleapis.com.", -"type": "string" +"ipv6AccessConfigs": { +"description": "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.", +"items": { +"$ref": "AccessConfig" }, -"resource": { -"description": "The user-defined name of the workload/instance. This value must be provided explicitly or in the urlMask. The resource identified by this value is platform-specific and is as follows: 1. API Gateway: The gateway ID 2. App Engine: The service name 3. Cloud Functions: The function name 4. Cloud Run: The service name ", -"type": "string" +"type": "array" }, -"urlMask": { -"description": "An URL mask is one of the main components of the Cloud Function. A template to parse platform-specific fields from a request URL. URL mask allows for routing to multiple resources on the same serverless platform without having to create multiple Network Endpoint Groups and backend resources. The fields parsed by this template are platform-specific and are as follows: 1. API Gateway: The gateway ID 2. App Engine: The service and version 3. Cloud Functions: The function name 4. Cloud Run: The service and tag ", +"ipv6AccessType": { +"description": "[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. Valid only if stackType is IPV4_IPV6.", +"enum": [ +"EXTERNAL", +"INTERNAL" +], +"enumDescriptions": [ +"This network interface can have external IPv6.", +"This network interface can have internal IPv6." +], "type": "string" }, -"version": { -"description": "The optional resource version. The version identified by this value is platform-specific and is follows: 1. API Gateway: Unused 2. App Engine: The service version 3. Cloud Functions: Unused 4. Cloud Run: The service tag ", +"ipv6Address": { +"description": "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.", "type": "string" -} -}, -"type": "object" }, -"NetworkEndpointGroupsAttachEndpointsRequest": { -"id": "NetworkEndpointGroupsAttachEndpointsRequest", -"properties": { -"networkEndpoints": { -"description": "The list of network endpoints to be attached.", -"items": { -"$ref": "NetworkEndpoint" +"kind": { +"default": "compute#networkInterface", +"description": "[Output Only] Type of the resource. Always compute#networkInterface for network interfaces.", +"type": "string" }, -"type": "array" -} +"name": { +"description": "[Output Only] The name of the network interface, which is generated by the server. For a VM, the network interface uses the nicN naming format. Where N is a value between 0 and 7. The default interface value is nic0.", +"type": "string" }, -"type": "object" +"network": { +"description": "URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default ", +"type": "string" }, -"NetworkEndpointGroupsDetachEndpointsRequest": { -"id": "NetworkEndpointGroupsDetachEndpointsRequest", -"properties": { -"networkEndpoints": { -"description": "The list of network endpoints to be detached.", -"items": { -"$ref": "NetworkEndpoint" +"networkAttachment": { +"description": "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}.", +"type": "string" }, -"type": "array" -} +"networkIP": { +"description": "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.", +"type": "string" }, -"type": "object" +"nicType": { +"description": "The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.", +"enum": [ +"GVNIC", +"IDPF", +"IRDMA", +"MRDMA", +"UNSPECIFIED_NIC_TYPE", +"VIRTIO_NET" +], +"enumDescriptions": [ +"GVNIC", +"IDPF", +"IRDMA", +"MRDMA", +"No type specified.", +"VIRTIO" +], +"type": "string" }, -"NetworkEndpointGroupsListEndpointsRequest": { -"id": "NetworkEndpointGroupsListEndpointsRequest", -"properties": { -"endpointFilters": { -"description": "Optional list of endpoints to query. This is a more efficient but also limited version of filter parameter. Endpoints in the filter must have ip_address and port fields populated, other fields are not supported.", -"items": { -"$ref": "NetworkEndpointGroupsListEndpointsRequestNetworkEndpointFilter" +"parentNicName": { +"description": "Name of the parent network interface of a dynamic network interface.", +"type": "string" }, -"type": "array" +"queueCount": { +"description": "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.", +"format": "int32", +"type": "integer" }, -"healthStatus": { -"description": "Optional query parameter for showing the health status of each network endpoint. Valid options are SKIP or SHOW. If you don't specify this parameter, the health status of network endpoints will not be provided.", +"stackType": { +"description": "The stack type for this network interface. To assign only IPv4 addresses, use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, use IPV4_IPV6. If not specified, IPV4_ONLY is used. This field can be both set at instance creation and update network interface operations.", "enum": [ -"SHOW", -"SKIP" +"IPV4_IPV6", +"IPV4_ONLY", +"IPV6_ONLY" ], "enumDescriptions": [ -"Show the health status for each network endpoint. Impacts latency of the call.", -"Health status for network endpoints will not be provided." +"The network interface can have both IPv4 and IPv6 addresses.", +"The network interface will only be assigned IPv4 addresses.", +"The network interface will only be assigned IPv6 addresses." ], "type": "string" -} }, -"type": "object" +"subnetwork": { +"description": "The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/regions/region /subnetworks/subnetwork - regions/region/subnetworks/subnetwork ", +"type": "string" }, -"NetworkEndpointGroupsListEndpointsRequestNetworkEndpointFilter": { -"id": "NetworkEndpointGroupsListEndpointsRequestNetworkEndpointFilter", -"properties": { -"networkEndpoint": { -"$ref": "NetworkEndpoint" +"vlan": { +"description": "VLAN tag of a dynamic network interface, must be an integer in the range from 2 to 255 inclusively.", +"format": "int32", +"type": "integer" } }, "type": "object" }, -"NetworkEndpointGroupsListNetworkEndpoints": { -"id": "NetworkEndpointGroupsListNetworkEndpoints", +"NetworkList": { +"description": "Contains a list of networks.", +"id": "NetworkList", "properties": { "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { -"description": "A list of NetworkEndpointWithHealthStatus resources.", +"description": "A list of Network resources.", "items": { -"$ref": "NetworkEndpointWithHealthStatus" +"$ref": "Network" }, "type": "array" }, "kind": { -"default": "compute#networkEndpointGroupsListNetworkEndpoints", -"description": "[Output Only] The resource type, which is always compute#networkEndpointGroupsListNetworkEndpoints for the list of network endpoints in the specified network endpoint group.", +"default": "compute#networkList", +"description": "[Output Only] Type of resource. Always compute#networkList for lists of networks.", "type": "string" }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, +"selfLink": { +"description": "[Output Only] Server-defined URL for this resource.", +"type": "string" +}, "warning": { "description": "[Output Only] Informational warning message.", "properties": { @@ -73519,18 +75765,241 @@ false }, "type": "object" }, -"NetworkEndpointGroupsScopedList": { -"id": "NetworkEndpointGroupsScopedList", +"NetworkParams": { +"description": "Additional network parameters.", +"id": "NetworkParams", "properties": { -"networkEndpointGroups": { -"description": "[Output Only] The list of network endpoint groups that are contained in this scope.", +"resourceManagerTags": { +"additionalProperties": { +"type": "string" +}, +"description": "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.", +"type": "object" +} +}, +"type": "object" +}, +"NetworkPeering": { +"description": "A network peering attached to a network resource. The message includes the peering name, peer network, peering state, and a flag indicating whether Google Compute Engine should automatically create routes for the peering.", +"id": "NetworkPeering", +"properties": { +"autoCreateRoutes": { +"description": "This field will be deprecated soon. Use the exchange_subnet_routes field instead. Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE.", +"type": "boolean" +}, +"connectionStatus": { +"$ref": "NetworkPeeringConnectionStatus", +"description": "[Output Only] The effective state of the peering connection as a whole." +}, +"exchangeSubnetRoutes": { +"description": "Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE.", +"type": "boolean" +}, +"exportCustomRoutes": { +"description": "Whether to export the custom routes to peer network. The default value is false.", +"type": "boolean" +}, +"exportSubnetRoutesWithPublicIp": { +"description": "Whether subnet routes with public IP range are exported. The default value is true, all subnet routes are exported. IPv4 special-use ranges are always exported to peers and are not controlled by this field.", +"type": "boolean" +}, +"importCustomRoutes": { +"description": "Whether to import the custom routes from peer network. The default value is false.", +"type": "boolean" +}, +"importSubnetRoutesWithPublicIp": { +"description": "Whether subnet routes with public IP range are imported. The default value is false. IPv4 special-use ranges are always imported from peers and are not controlled by this field.", +"type": "boolean" +}, +"name": { +"description": "Name of this peering. Provided by the client when the peering is created. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", +"type": "string" +}, +"network": { +"description": "The URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network.", +"type": "string" +}, +"peerMtu": { +"description": "[Output Only] Maximum Transmission Unit in bytes of the peer network.", +"format": "int32", +"type": "integer" +}, +"stackType": { +"description": "Which IP version(s) of traffic and routes are allowed to be imported or exported between peer networks. The default value is IPV4_ONLY.", +"enum": [ +"IPV4_IPV6", +"IPV4_ONLY" +], +"enumDescriptions": [ +"This Peering will allow IPv4 traffic and routes to be exchanged. Additionally if the matching peering is IPV4_IPV6, IPv6 traffic and routes will be exchanged as well.", +"This Peering will only allow IPv4 traffic and routes to be exchanged, even if the matching peering is IPV4_IPV6." +], +"type": "string" +}, +"state": { +"description": "[Output Only] State for the peering, either `ACTIVE` or `INACTIVE`. The peering is `ACTIVE` when there's a matching configuration in the peer network.", +"enum": [ +"ACTIVE", +"INACTIVE" +], +"enumDescriptions": [ +"Matching configuration exists on the peer.", +"There is no matching configuration on the peer, including the case when peer does not exist." +], +"type": "string" +}, +"stateDetails": { +"description": "[Output Only] Details about the current state of the peering.", +"type": "string" +}, +"updateStrategy": { +"description": "The update strategy determines the semantics for updates and deletes to the peering connection configuration.", +"enum": [ +"CONSENSUS", +"INDEPENDENT", +"UNSPECIFIED" +], +"enumDescriptions": [ +"Updates are reflected in the local peering but aren't applied to the peering connection until a complementary change is made to the matching peering. To delete a peering with the consensus update strategy, both the peerings must request the deletion of the peering before the peering can be deleted.", +"In this mode, changes to the peering configuration can be unilaterally altered by changing either side of the peering. This is the default value if the field is unspecified.", +"Peerings with update strategy UNSPECIFIED are created with update strategy INDEPENDENT." +], +"type": "string" +} +}, +"type": "object" +}, +"NetworkPeeringConnectionStatus": { +"description": "[Output Only] Describes the state of a peering connection, not just the local peering. This field provides information about the effective settings for the connection as a whole, including pending delete/update requests for CONSENSUS peerings.", +"id": "NetworkPeeringConnectionStatus", +"properties": { +"consensusState": { +"$ref": "NetworkPeeringConnectionStatusConsensusState", +"description": "The consensus state contains information about the status of update and delete for a consensus peering connection." +}, +"trafficConfiguration": { +"$ref": "NetworkPeeringConnectionStatusTrafficConfiguration", +"description": "The active connectivity settings for the peering connection based on the settings of the network peerings." +}, +"updateStrategy": { +"description": "The update strategy determines the update/delete semantics for this peering connection.", +"enum": [ +"CONSENSUS", +"INDEPENDENT", +"UNSPECIFIED" +], +"enumDescriptions": [ +"Updates are reflected in the local peering but aren't applied to the peering connection until a complementary change is made to the matching peering. To delete a peering with the consensus update strategy, both the peerings must request the deletion of the peering before the peering can be deleted.", +"In this mode, changes to the peering configuration can be unilaterally altered by changing either side of the peering. This is the default value if the field is unspecified.", +"Peerings with update strategy UNSPECIFIED are created with update strategy INDEPENDENT." +], +"type": "string" +} +}, +"type": "object" +}, +"NetworkPeeringConnectionStatusConsensusState": { +"description": "The status of update/delete for a consensus peering connection. Only set when connection_status.update_strategy is CONSENSUS or a network peering is proposing to update the strategy to CONSENSUS.", +"id": "NetworkPeeringConnectionStatusConsensusState", +"properties": { +"deleteStatus": { +"description": "The status of the delete request.", +"enum": [ +"DELETE_ACKNOWLEDGED", +"DELETE_STATUS_UNSPECIFIED", +"LOCAL_DELETE_REQUESTED", +"PEER_DELETE_REQUESTED" +], +"enumDescriptions": [ +"Both network admins have agreed this consensus peering connection can be deleted.", +"", +"Network admin has requested deletion of this peering connection.", +"The peer network admin has requested deletion of this peering connection." +], +"type": "string" +}, +"updateStatus": { +"description": "The status of the update request.", +"enum": [ +"IN_SYNC", +"PENDING_LOCAL_ACKNOWLEDMENT", +"PENDING_PEER_ACKNOWLEDGEMENT", +"UPDATE_STATUS_UNSPECIFIED" +], +"enumDescriptions": [ +"No pending configuration update proposals to the peering connection.", +"The peer network admin has made an updatePeering call. The change is awaiting acknowledgment from this peering's network admin.", +"The local network admin has made an updatePeering call. The change is awaiting acknowledgment from the peer network admin.", +"" +], +"type": "string" +} +}, +"type": "object" +}, +"NetworkPeeringConnectionStatusTrafficConfiguration": { +"id": "NetworkPeeringConnectionStatusTrafficConfiguration", +"properties": { +"exportCustomRoutesToPeer": { +"description": "Whether custom routes are being exported to the peer network.", +"type": "boolean" +}, +"exportSubnetRoutesWithPublicIpToPeer": { +"description": "Whether subnet routes with public IP ranges are being exported to the peer network.", +"type": "boolean" +}, +"importCustomRoutesFromPeer": { +"description": "Whether custom routes are being imported from the peer network.", +"type": "boolean" +}, +"importSubnetRoutesWithPublicIpFromPeer": { +"description": "Whether subnet routes with public IP ranges are being imported from the peer network.", +"type": "boolean" +}, +"stackType": { +"description": "Which IP version(s) of traffic and routes are being imported or exported between peer networks.", +"enum": [ +"IPV4_IPV6", +"IPV4_ONLY" +], +"enumDescriptions": [ +"This Peering will allow IPv4 traffic and routes to be exchanged. Additionally if the matching peering is IPV4_IPV6, IPv6 traffic and routes will be exchanged as well.", +"This Peering will only allow IPv4 traffic and routes to be exchanged, even if the matching peering is IPV4_IPV6." +], +"type": "string" +} +}, +"type": "object" +}, +"NetworkPerformanceConfig": { +"id": "NetworkPerformanceConfig", +"properties": { +"totalEgressBandwidthTier": { +"enum": [ +"DEFAULT", +"TIER_1" +], +"enumDescriptions": [ +"", +"" +], +"type": "string" +} +}, +"type": "object" +}, +"NetworkPoliciesScopedList": { +"id": "NetworkPoliciesScopedList", +"properties": { +"networkPolicies": { +"description": "A list of network policies contained in this scope.", "items": { -"$ref": "NetworkEndpointGroup" +"$ref": "NetworkPolicy" }, "type": "array" }, "warning": { -"description": "[Output Only] An informational warning that replaces the list of network endpoint groups when the list is empty.", +"description": "Informational warning which replaces the list of network policies when the list is empty.", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", @@ -73656,25 +76125,68 @@ false }, "type": "object" }, -"NetworkEndpointWithHealthStatus": { -"id": "NetworkEndpointWithHealthStatus", +"NetworkPolicy": { +"description": "Represents a Network Policy resource.", +"id": "NetworkPolicy", "properties": { -"healths": { -"description": "[Output only] The health status of network endpoint. Optional. Displayed only if the network endpoint has centralized health checking configured.", +"associations": { +"description": "[Output Only] A list of associations that belong to this network policy.", "items": { -"$ref": "HealthStatusForNetworkEndpoint" +"$ref": "NetworkPolicyAssociation" }, "type": "array" }, -"networkEndpoint": { -"$ref": "NetworkEndpoint", -"description": "[Output only] The network endpoint." +"creationTimestamp": { +"description": "[Output Only] Creation timestamp in RFC3339 text format.", +"type": "string" +}, +"description": { +"description": "An optional description of this resource. Provide this property when you create the resource.", +"type": "string" +}, +"id": { +"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", +"format": "uint64", +"type": "string" +}, +"kind": { +"default": "compute#networkPolicy", +"description": "[Output only] Type of the resource. Always compute#networkPolicy for network policies", +"type": "string" +}, +"name": { +"description": "Name of the resource.", +"type": "string" +}, +"region": { +"description": "[Output Only] URL of the region where the regional network policy resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", +"type": "string" +}, +"ruleTupleCount": { +"description": "[Output Only] Total count of all network policy rule tuples. A network policy can not exceed a set number of tuples.", +"format": "int32", +"type": "integer" +}, +"selfLink": { +"description": "[Output Only] Server-defined URL for the resource.", +"type": "string" +}, +"selfLinkWithId": { +"description": "[Output Only] Server-defined URL for this resource with the resource id.", +"type": "string" +}, +"trafficClassificationRules": { +"description": "[Output Only] A list of traffic classification rules that belong to this policy.", +"items": { +"$ref": "NetworkPolicyTrafficClassificationRule" +}, +"type": "array" } }, "type": "object" }, -"NetworkFirewallPolicyAggregatedList": { -"id": "NetworkFirewallPolicyAggregatedList", +"NetworkPolicyAggregatedList": { +"id": "NetworkPolicyAggregatedList", "properties": { "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", @@ -73682,15 +76194,15 @@ false }, "items": { "additionalProperties": { -"$ref": "FirewallPoliciesScopedList", +"$ref": "NetworkPoliciesScopedList", "description": "Name of the scope containing this set of addresses." }, -"description": "A list of FirewallPoliciesScopedList resources.", +"description": "A list of NetworkPoliciesScopedList resources.", "type": "object" }, "kind": { -"default": "compute#networkFirewallPolicyAggregatedList", -"description": "[Output Only] Type of resource. Always compute#networkFirewallPoliciesAggregatedList for lists of network firewall policies.", +"default": "compute#networkPolicyAggregatedList", +"description": "[Output Only] Type of resource. Always compute#networkPolicyAggregatedList for lists of network policies.", "type": "string" }, "nextPageToken": { @@ -73835,173 +76347,43 @@ false }, "type": "object" }, -"NetworkInterface": { -"description": "A network interface resource attached to an instance.", -"id": "NetworkInterface", +"NetworkPolicyAssociation": { +"id": "NetworkPolicyAssociation", "properties": { -"accessConfigs": { -"description": "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.", -"items": { -"$ref": "AccessConfig" -}, -"type": "array" -}, -"aliasIpRanges": { -"description": "An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.", -"items": { -"$ref": "AliasIpRange" -}, -"type": "array" -}, -"fingerprint": { -"description": "Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.", -"format": "byte", -"type": "string" -}, -"igmpQuery": { -"description": "Indicate whether igmp query is enabled on the network interface or not. If enabled, also indicates the version of IGMP supported.", -"enum": [ -"IGMP_QUERY_DISABLED", -"IGMP_QUERY_V2" -], -"enumDescriptions": [ -"The network interface has disabled IGMP query.", -"The network interface has enabled IGMP query - v2." -], -"type": "string" -}, -"internalIpv6PrefixLength": { -"description": "The prefix length of the primary internal IPv6 range.", -"format": "int32", -"type": "integer" -}, -"ipv6AccessConfigs": { -"description": "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.", -"items": { -"$ref": "AccessConfig" -}, -"type": "array" -}, -"ipv6AccessType": { -"description": "[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. Valid only if stackType is IPV4_IPV6.", -"enum": [ -"EXTERNAL", -"INTERNAL" -], -"enumDescriptions": [ -"This network interface can have external IPv6.", -"This network interface can have internal IPv6." -], -"type": "string" -}, -"ipv6Address": { -"description": "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.", -"type": "string" -}, -"kind": { -"default": "compute#networkInterface", -"description": "[Output Only] Type of the resource. Always compute#networkInterface for network interfaces.", +"attachmentTarget": { +"description": "The target that the network policy is attached to.", "type": "string" }, "name": { -"description": "[Output Only] The name of the network interface, which is generated by the server. For a VM, the network interface uses the nicN naming format. Where N is a value between 0 and 7. The default interface value is nic0.", -"type": "string" -}, -"network": { -"description": "URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default ", -"type": "string" -}, -"networkAttachment": { -"description": "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}.", -"type": "string" -}, -"networkIP": { -"description": "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.", -"type": "string" -}, -"nicType": { -"description": "The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.", -"enum": [ -"GVNIC", -"IDPF", -"IRDMA", -"MRDMA", -"UNSPECIFIED_NIC_TYPE", -"VIRTIO_NET" -], -"enumDescriptions": [ -"GVNIC", -"IDPF", -"IRDMA", -"MRDMA", -"No type specified.", -"VIRTIO" -], -"type": "string" -}, -"parentNicName": { -"description": "Name of the parent network interface of a dynamic network interface.", -"type": "string" -}, -"queueCount": { -"description": "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.", -"format": "int32", -"type": "integer" -}, -"stackType": { -"description": "The stack type for this network interface. To assign only IPv4 addresses, use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, use IPV4_IPV6. If not specified, IPV4_ONLY is used. This field can be both set at instance creation and update network interface operations.", -"enum": [ -"IPV4_IPV6", -"IPV4_ONLY", -"IPV6_ONLY" -], -"enumDescriptions": [ -"The network interface can have both IPv4 and IPv6 addresses.", -"The network interface will only be assigned IPv4 addresses.", -"The network interface will only be assigned IPv6 addresses." -], -"type": "string" -}, -"subnetwork": { -"description": "The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/regions/region /subnetworks/subnetwork - regions/region/subnetworks/subnetwork ", +"description": "The name for an association.", "type": "string" -}, -"vlan": { -"description": "VLAN tag of a dynamic network interface, must be an integer in the range from 2 to 255 inclusively.", -"format": "int32", -"type": "integer" } }, "type": "object" }, -"NetworkList": { -"description": "Contains a list of networks.", -"id": "NetworkList", +"NetworkPolicyList": { +"id": "NetworkPolicyList", "properties": { "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { -"description": "A list of Network resources.", +"description": "A list of NetworkPolicy resources.", "items": { -"$ref": "Network" +"$ref": "NetworkPolicy" }, "type": "array" }, "kind": { -"default": "compute#networkList", -"description": "[Output Only] Type of resource. Always compute#networkList for lists of networks.", +"default": "compute#networkPolicyList", +"description": "[Output Only] Type of resource. Always compute#networkPolicyList for lists of network policies.", "type": "string" }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, -"selfLink": { -"description": "[Output Only] Server-defined URL for this resource.", -"type": "string" -}, "warning": { "description": "[Output Only] Informational warning message.", "properties": { @@ -74129,222 +76511,172 @@ false }, "type": "object" }, -"NetworkParams": { -"description": "Additional network parameters.", -"id": "NetworkParams", +"NetworkPolicyTrafficClassificationRule": { +"description": "Represents a traffic classification rule that describes one or more match conditions along with the action to be taken when traffic matches this condition.", +"id": "NetworkPolicyTrafficClassificationRule", "properties": { -"resourceManagerTags": { -"additionalProperties": { -"type": "string" -}, -"description": "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.", -"type": "object" -} -}, -"type": "object" -}, -"NetworkPeering": { -"description": "A network peering attached to a network resource. The message includes the peering name, peer network, peering state, and a flag indicating whether Google Compute Engine should automatically create routes for the peering.", -"id": "NetworkPeering", -"properties": { -"autoCreateRoutes": { -"description": "This field will be deprecated soon. Use the exchange_subnet_routes field instead. Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE.", -"type": "boolean" -}, -"connectionStatus": { -"$ref": "NetworkPeeringConnectionStatus", -"description": "[Output Only] The effective state of the peering connection as a whole." -}, -"exchangeSubnetRoutes": { -"description": "Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE.", -"type": "boolean" +"action": { +"$ref": "NetworkPolicyTrafficClassificationRuleAction", +"description": "The Action to perform when the client connection triggers the rule." }, -"exportCustomRoutes": { -"description": "Whether to export the custom routes to peer network. The default value is false.", -"type": "boolean" +"description": { +"description": "An optional description for this resource.", +"type": "string" }, -"exportSubnetRoutesWithPublicIp": { -"description": "Whether subnet routes with public IP range are exported. The default value is true, all subnet routes are exported. IPv4 special-use ranges are always exported to peers and are not controlled by this field.", +"disabled": { +"description": "Denotes whether the network policy rule is disabled. When set to true, the network policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the network policy rule will be enabled.", "type": "boolean" }, -"importCustomRoutes": { -"description": "Whether to import the custom routes from peer network. The default value is false.", -"type": "boolean" +"kind": { +"default": "compute#networkPolicyTrafficClassificationRule", +"description": "[Output only] Type of the resource. Always compute#networkPolicyTrafficClassificationRule for network policy traffic classification rules", +"type": "string" }, -"importSubnetRoutesWithPublicIp": { -"description": "Whether subnet routes with public IP range are imported. The default value is false. IPv4 special-use ranges are always imported from peers and are not controlled by this field.", -"type": "boolean" +"match": { +"$ref": "NetworkPolicyTrafficClassificationRuleMatcher", +"description": "A match condition that outgoing traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced." }, -"name": { -"description": "Name of this peering. Provided by the client when the peering is created. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", -"type": "string" +"priority": { +"description": "An integer indicating the priority of a rule in the list. The priority must be a positive value between 1 and 2147482647. The priority values from 2147482648 to 2147483647 (1000) are reserved for system default network policy rules. Rules are evaluated from highest to lowest priority where 1 is the highest priority and 2147483647 is the lowest priority.", +"format": "int32", +"type": "integer" }, -"network": { -"description": "The URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network.", +"ruleName": { +"description": "An optional name for the rule. This field is not a unique identifier and can be updated.", "type": "string" }, -"peerMtu": { -"description": "[Output Only] Maximum Transmission Unit in bytes of the peer network.", +"ruleTupleCount": { +"description": "[Output Only] Calculation of the complexity of a single network policy rule.", "format": "int32", "type": "integer" }, -"stackType": { -"description": "Which IP version(s) of traffic and routes are allowed to be imported or exported between peer networks. The default value is IPV4_ONLY.", -"enum": [ -"IPV4_IPV6", -"IPV4_ONLY" -], -"enumDescriptions": [ -"This Peering will allow IPv4 traffic and routes to be exchanged. Additionally if the matching peering is IPV4_IPV6, IPv6 traffic and routes will be exchanged as well.", -"This Peering will only allow IPv4 traffic and routes to be exchanged, even if the matching peering is IPV4_IPV6." -], -"type": "string" +"targetSecureTags": { +"description": "A list of secure tags that controls which instances the traffic classification rule applies to. If targetSecureTag are specified, then the traffic classification rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the targetSecureTag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the traffic classification rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.", +"items": { +"$ref": "NetworkPolicyTrafficClassificationRuleSecureTag" }, -"state": { -"description": "[Output Only] State for the peering, either `ACTIVE` or `INACTIVE`. The peering is `ACTIVE` when there's a matching configuration in the peer network.", -"enum": [ -"ACTIVE", -"INACTIVE" -], -"enumDescriptions": [ -"Matching configuration exists on the peer.", -"There is no matching configuration on the peer, including the case when peer does not exist." -], -"type": "string" +"type": "array" }, -"stateDetails": { -"description": "[Output Only] Details about the current state of the peering.", +"targetServiceAccounts": { +"description": "A list of service accounts indicating the sets of instances that are applied with this rule.", +"items": { "type": "string" }, -"updateStrategy": { -"description": "The update strategy determines the semantics for updates and deletes to the peering connection configuration.", -"enum": [ -"CONSENSUS", -"INDEPENDENT", -"UNSPECIFIED" -], -"enumDescriptions": [ -"Updates are reflected in the local peering but aren't applied to the peering connection until a complementary change is made to the matching peering. To delete a peering with the consensus update strategy, both the peerings must request the deletion of the peering before the peering can be deleted.", -"In this mode, changes to the peering configuration can be unilaterally altered by changing either side of the peering. This is the default value if the field is unspecified.", -"Peerings with update strategy UNSPECIFIED are created with update strategy INDEPENDENT." -], -"type": "string" +"type": "array" } }, "type": "object" }, -"NetworkPeeringConnectionStatus": { -"description": "[Output Only] Describes the state of a peering connection, not just the local peering. This field provides information about the effective settings for the connection as a whole, including pending delete/update requests for CONSENSUS peerings.", -"id": "NetworkPeeringConnectionStatus", +"NetworkPolicyTrafficClassificationRuleAction": { +"id": "NetworkPolicyTrafficClassificationRuleAction", "properties": { -"consensusState": { -"$ref": "NetworkPeeringConnectionStatusConsensusState", -"description": "The consensus state contains information about the status of update and delete for a consensus peering connection." -}, -"trafficConfiguration": { -"$ref": "NetworkPeeringConnectionStatusTrafficConfiguration", -"description": "The active connectivity settings for the peering connection based on the settings of the network peerings." -}, -"updateStrategy": { -"description": "The update strategy determines the update/delete semantics for this peering connection.", +"dscpMode": { +"description": "The traffic class that should be applied to the matching packet.", "enum": [ -"CONSENSUS", -"INDEPENDENT", -"UNSPECIFIED" +"AUTO", +"CUSTOM" ], "enumDescriptions": [ -"Updates are reflected in the local peering but aren't applied to the peering connection until a complementary change is made to the matching peering. To delete a peering with the consensus update strategy, both the peerings must request the deletion of the peering before the peering can be deleted.", -"In this mode, changes to the peering configuration can be unilaterally altered by changing either side of the peering. This is the default value if the field is unspecified.", -"Peerings with update strategy UNSPECIFIED are created with update strategy INDEPENDENT." +"DSCP value will be automatically picked up based on configured traffic_class.", +"Allows to specify custom DSCP value from selected traffic_class range." ], "type": "string" -} }, -"type": "object" +"dscpValue": { +"description": "Custom DSCP value from 0-63 range.", +"format": "int32", +"type": "integer" }, -"NetworkPeeringConnectionStatusConsensusState": { -"description": "The status of update/delete for a consensus peering connection. Only set when connection_status.update_strategy is CONSENSUS or a network peering is proposing to update the strategy to CONSENSUS.", -"id": "NetworkPeeringConnectionStatusConsensusState", -"properties": { -"deleteStatus": { -"description": "The status of the delete request.", +"trafficClass": { +"description": "The traffic class that should be applied to the matching packet.", "enum": [ -"DELETE_ACKNOWLEDGED", -"DELETE_STATUS_UNSPECIFIED", -"LOCAL_DELETE_REQUESTED", -"PEER_DELETE_REQUESTED" +"TC1", +"TC2", +"TC3", +"TC4", +"TC5", +"TC6" ], "enumDescriptions": [ -"Both network admins have agreed this consensus peering connection can be deleted.", -"", -"Network admin has requested deletion of this peering connection.", -"The peer network admin has requested deletion of this peering connection." +"Traffic Class 1, corresponding to DSCP ranges (0-7) 000xxx.", +"Traffic Class 2, corresponding to DSCP ranges (8-15) 001xxx.", +"Traffic Class 3, corresponding to DSCP ranges (16-23) 010xxx.", +"Traffic Class 4, corresponding to DSCP ranges (24-31) 011xxx.", +"Traffic Class 5, corresponding to DSCP ranges (32-47) 10xxxx.", +"Traffic Class 6, corresponding to DSCP ranges (48-63) 11xxxx." ], "type": "string" }, -"updateStatus": { -"description": "The status of the update request.", -"enum": [ -"IN_SYNC", -"PENDING_LOCAL_ACKNOWLEDMENT", -"PENDING_PEER_ACKNOWLEDGEMENT", -"UPDATE_STATUS_UNSPECIFIED" -], -"enumDescriptions": [ -"No pending configuration update proposals to the peering connection.", -"The peer network admin has made an updatePeering call. The change is awaiting acknowledgment from this peering's network admin.", -"The local network admin has made an updatePeering call. The change is awaiting acknowledgment from the peer network admin.", -"" -], +"type": { +"description": "Always \"apply_traffic_classification\" for traffic classification rules.", "type": "string" } }, "type": "object" }, -"NetworkPeeringConnectionStatusTrafficConfiguration": { -"id": "NetworkPeeringConnectionStatusTrafficConfiguration", +"NetworkPolicyTrafficClassificationRuleMatcher": { +"description": "Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified.", +"id": "NetworkPolicyTrafficClassificationRuleMatcher", "properties": { -"exportCustomRoutesToPeer": { -"description": "Whether custom routes are being exported to the peer network.", -"type": "boolean" +"destIpRanges": { +"description": "CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000.", +"items": { +"type": "string" }, -"exportSubnetRoutesWithPublicIpToPeer": { -"description": "Whether subnet routes with public IP ranges are being exported to the peer network.", -"type": "boolean" +"type": "array" }, -"importCustomRoutesFromPeer": { -"description": "Whether custom routes are being imported from the peer network.", -"type": "boolean" +"layer4Configs": { +"description": "Pairs of IP protocols and ports that the rule should match.", +"items": { +"$ref": "NetworkPolicyTrafficClassificationRuleMatcherLayer4Config" }, -"importSubnetRoutesWithPublicIpFromPeer": { -"description": "Whether subnet routes with public IP ranges are being imported from the peer network.", -"type": "boolean" +"type": "array" }, -"stackType": { -"description": "Which IP version(s) of traffic and routes are being imported or exported between peer networks.", -"enum": [ -"IPV4_IPV6", -"IPV4_ONLY" -], -"enumDescriptions": [ -"This Peering will allow IPv4 traffic and routes to be exchanged. Additionally if the matching peering is IPV4_IPV6, IPv6 traffic and routes will be exchanged as well.", -"This Peering will only allow IPv4 traffic and routes to be exchanged, even if the matching peering is IPV4_IPV6." -], +"srcIpRanges": { +"description": "CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000.", +"items": { "type": "string" +}, +"type": "array" } }, "type": "object" }, -"NetworkPerformanceConfig": { -"id": "NetworkPerformanceConfig", +"NetworkPolicyTrafficClassificationRuleMatcherLayer4Config": { +"id": "NetworkPolicyTrafficClassificationRuleMatcherLayer4Config", "properties": { -"totalEgressBandwidthTier": { +"ipProtocol": { +"description": "The IP protocol to which this rule applies. The protocol type is required when creating a traffic classification rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.", +"type": "string" +}, +"ports": { +"description": "An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: [\"22\"], [\"80\",\"443\"], and [\"12345-12349\"].", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"NetworkPolicyTrafficClassificationRuleSecureTag": { +"id": "NetworkPolicyTrafficClassificationRuleSecureTag", +"properties": { +"name": { +"description": "Name of the secure tag, created with TagManager's TagValue API.", +"pattern": "tagValues/[0-9]+", +"type": "string" +}, +"state": { +"description": "[Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.", "enum": [ -"DEFAULT", -"TIER_1" +"EFFECTIVE", +"INEFFECTIVE", +"STATE_UNSPECIFIED" ], "enumDescriptions": [ "", +"", "" ], "type": "string" @@ -80181,6 +82513,10 @@ false "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, +"enableEnhancedIpv4Allocation": { +"description": "[Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only.", +"type": "boolean" +}, "fingerprint": { "description": "Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix.", "format": "byte", @@ -80603,6 +82939,10 @@ false "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, +"enableEnhancedIpv4Allocation": { +"description": "[Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only.", +"type": "boolean" +}, "ipCidrRange": { "description": "The IP address range, in CIDR format, represented by this sub public delegated prefix.", "type": "string" @@ -84427,6 +86767,72 @@ false }, "type": "object" }, +"ReservationSubBlocksReportFaultyRequest": { +"id": "ReservationSubBlocksReportFaultyRequest", +"properties": { +"disruptionSchedule": { +"description": "The disruption schedule for the subBlock.", +"enum": [ +"DISRUPTION_SCHEDULE_UNSPECIFIED", +"IMMEDIATE" +], +"enumDescriptions": [ +"", +"All VMs will be disrupted immediately." +], +"type": "string" +}, +"failureComponent": { +"description": "The component that experienced the fault.", +"enum": [ +"FAILURE_COMPONENT_UNSPECIFIED", +"MULTIPLE_FAULTY_HOSTS", +"NVLINK_SWITCH" +], +"enumDescriptions": [ +"", +"Multiple hosts experienced the fault.", +"The NVLink switch experienced the fault." +], +"type": "string" +}, +"faultReasons": { +"description": "The reasons for the fault experienced with the subBlock.", +"items": { +"$ref": "ReservationSubBlocksReportFaultyRequestFaultReason" +}, +"type": "array" +} +}, +"type": "object" +}, +"ReservationSubBlocksReportFaultyRequestFaultReason": { +"description": "The reason for the fault experienced with the subBlock.", +"id": "ReservationSubBlocksReportFaultyRequestFaultReason", +"properties": { +"behavior": { +"description": "The behavior of the fault experienced with the subBlock.", +"enum": [ +"FAULT_BEHAVIOR_UNSPECIFIED", +"GPU_ERROR", +"PERFORMANCE", +"SWITCH_FAILURE" +], +"enumDescriptions": [ +"", +"The subBlock experienced a GPU error.", +"The subBlock experienced performance issues.", +"The subBlock experienced a switch failure." +], +"type": "string" +}, +"description": { +"description": "The description of the fault experienced with the subBlock.", +"type": "string" +} +}, +"type": "object" +}, "ReservationsBlocksPerformMaintenanceRequest": { "id": "ReservationsBlocksPerformMaintenanceRequest", "properties": { @@ -91077,7 +93483,7 @@ false "type": "object" }, "Snapshot": { -"description": "Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. LINT.IfChange", +"description": "Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots.", "id": "Snapshot", "properties": { "architecture": { @@ -91192,6 +93598,10 @@ false "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, +"params": { +"$ref": "SnapshotParams", +"description": "Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload." +}, "region": { "description": "[Output Only] URL of the region where the snapshot resides. Only applicable for regional snapshots.", "type": "string" @@ -91633,6 +94043,20 @@ false }, "type": "object" }, +"SnapshotParams": { +"description": "Additional snapshot params.", +"id": "SnapshotParams", +"properties": { +"resourceManagerTags": { +"additionalProperties": { +"type": "string" +}, +"description": "Resource manager tags to be bound to the snapshot. 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.", +"type": "object" +} +}, +"type": "object" +}, "SnapshotSettings": { "id": "SnapshotSettings", "properties": { diff --git a/googleapiclient/discovery_cache/documents/compute.v1.json b/googleapiclient/discovery_cache/documents/compute.v1.json index c22ae95f047..6f41d282ed1 100644 --- a/googleapiclient/discovery_cache/documents/compute.v1.json +++ b/googleapiclient/discovery_cache/documents/compute.v1.json @@ -1793,6 +1793,38 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, +"getEffectiveSecurityPolicies": { +"description": "Returns effective security policies applied to this backend service.", +"flatPath": "projects/{project}/global/backendServices/{backendService}/getEffectiveSecurityPolicies", +"httpMethod": "GET", +"id": "compute.backendServices.getEffectiveSecurityPolicies", +"parameterOrder": [ +"project", +"backendService" +], +"parameters": { +"backendService": { +"description": "Name of the Backend Service for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"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/backendServices/{backendService}/getEffectiveSecurityPolicies", +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, "getHealth": { "description": "Gets the most recent health check results for this BackendService. Example request body: { \"group\": \"/zones/us-east1-b/instanceGroups/lb-backend-example\" }", "flatPath": "projects/{project}/global/backendServices/{backendService}/getHealth", @@ -19900,6 +19932,576 @@ } } }, +"organizationSecurityPolicies": { +"methods": { +"addAssociation": { +"description": "Inserts an association for the specified security policy. This has billing implications. Projects in the hierarchy with effective hierarchical security policies will be automatically enrolled into Cloud Armor Enterprise if not already enrolled. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.addAssociation instead if possible.", +"flatPath": "locations/global/securityPolicies/{securityPolicy}/addAssociation", +"httpMethod": "POST", +"id": "compute.organizationSecurityPolicies.addAssociation", +"parameterOrder": [ +"securityPolicy" +], +"parameters": { +"replaceExistingAssociation": { +"description": "Indicates whether or not to replace it if an association of the attachment already exists. This is false by default, in which case an error will be returned if an association already exists.", +"location": "query", +"type": "boolean" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"securityPolicy": { +"description": "Name of the security policy to update.", +"location": "path", +"pattern": "(securityPolicies/)?[0-9]{0,20}", +"required": true, +"type": "string" +} +}, +"path": "locations/global/securityPolicies/{securityPolicy}/addAssociation", +"request": { +"$ref": "SecurityPolicyAssociation" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"addRule": { +"description": "Inserts a rule into a security policy.", +"flatPath": "locations/global/securityPolicies/{securityPolicy}/addRule", +"httpMethod": "POST", +"id": "compute.organizationSecurityPolicies.addRule", +"parameterOrder": [ +"securityPolicy" +], +"parameters": { +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"securityPolicy": { +"description": "Name of the security policy to update.", +"location": "path", +"pattern": "(securityPolicies/)?[0-9]{0,20}", +"required": true, +"type": "string" +} +}, +"path": "locations/global/securityPolicies/{securityPolicy}/addRule", +"request": { +"$ref": "SecurityPolicyRule" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"copyRules": { +"description": "Copies rules to the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.copyRules instead.", +"flatPath": "locations/global/securityPolicies/{securityPolicy}/copyRules", +"httpMethod": "POST", +"id": "compute.organizationSecurityPolicies.copyRules", +"parameterOrder": [ +"securityPolicy" +], +"parameters": { +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"securityPolicy": { +"description": "Name of the security policy to update.", +"location": "path", +"pattern": "(securityPolicies/)?[0-9]{0,20}", +"required": true, +"type": "string" +}, +"sourceSecurityPolicy": { +"description": "The security policy from which to copy rules.", +"location": "query", +"type": "string" +} +}, +"path": "locations/global/securityPolicies/{securityPolicy}/copyRules", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"delete": { +"description": "Deletes the specified policy. Use of this API to remove firewall policies is deprecated. Use firewallPolicies.delete instead.", +"flatPath": "locations/global/securityPolicies/{securityPolicy}", +"httpMethod": "DELETE", +"id": "compute.organizationSecurityPolicies.delete", +"parameterOrder": [ +"securityPolicy" +], +"parameters": { +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"securityPolicy": { +"description": "Name of the security policy to delete.", +"location": "path", +"pattern": "(securityPolicies/)?[0-9]{0,20}", +"required": true, +"type": "string" +} +}, +"path": "locations/global/securityPolicies/{securityPolicy}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"get": { +"description": "List all of the ordered rules present in a single specified policy. Use of this API to read firewall policies is deprecated. Use firewallPolicies.get instead.", +"flatPath": "locations/global/securityPolicies/{securityPolicy}", +"httpMethod": "GET", +"id": "compute.organizationSecurityPolicies.get", +"parameterOrder": [ +"securityPolicy" +], +"parameters": { +"securityPolicy": { +"description": "Name of the security policy to get.", +"location": "path", +"pattern": "(securityPolicies/)?[0-9]{0,20}", +"required": true, +"type": "string" +} +}, +"path": "locations/global/securityPolicies/{securityPolicy}", +"response": { +"$ref": "SecurityPolicy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"getAssociation": { +"description": "Gets an association with the specified name. Use of this API to read firewall policies is deprecated. Use firewallPolicies.getAssociation instead if possible.", +"flatPath": "locations/global/securityPolicies/{securityPolicy}/getAssociation", +"httpMethod": "GET", +"id": "compute.organizationSecurityPolicies.getAssociation", +"parameterOrder": [ +"securityPolicy" +], +"parameters": { +"name": { +"description": "The name of the association to get from the security policy.", +"location": "query", +"type": "string" +}, +"securityPolicy": { +"description": "Name of the security policy to which the queried rule belongs.", +"location": "path", +"pattern": "(securityPolicies/)?[0-9]{0,20}", +"required": true, +"type": "string" +} +}, +"path": "locations/global/securityPolicies/{securityPolicy}/getAssociation", +"response": { +"$ref": "SecurityPolicyAssociation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"getRule": { +"description": "Gets a rule at the specified priority. Use of this API to read firewall policies is deprecated. Use firewallPolicies.getRule instead.", +"flatPath": "locations/global/securityPolicies/{securityPolicy}/getRule", +"httpMethod": "GET", +"id": "compute.organizationSecurityPolicies.getRule", +"parameterOrder": [ +"securityPolicy" +], +"parameters": { +"priority": { +"description": "The priority of the rule to get from the security policy.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"securityPolicy": { +"description": "Name of the security policy to which the queried rule belongs.", +"location": "path", +"pattern": "(securityPolicies/)?[0-9]{0,20}", +"required": true, +"type": "string" +} +}, +"path": "locations/global/securityPolicies/{securityPolicy}/getRule", +"response": { +"$ref": "SecurityPolicyRule" +}, +"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 policy in the specified project using the data included in the request. Use of this API to insert firewall policies is deprecated. Use firewallPolicies.insert instead.", +"flatPath": "locations/global/securityPolicies", +"httpMethod": "POST", +"id": "compute.organizationSecurityPolicies.insert", +"parameters": { +"parentId": { +"description": "Parent ID for this request. The ID can be either be \"folders/[FOLDER_ID]\" if the parent is a folder or \"organizations/[ORGANIZATION_ID]\" if the parent is an organization.", +"location": "query", +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "locations/global/securityPolicies", +"request": { +"$ref": "SecurityPolicy" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"list": { +"description": "List all the policies that have been configured for the specified project. Use of this API to read firewall policies is deprecated. Use firewallPolicies.list instead.", +"flatPath": "locations/global/securityPolicies", +"httpMethod": "GET", +"id": "compute.organizationSecurityPolicies.list", +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", +"location": "query", +"type": "string" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", +"location": "query", +"type": "string" +}, +"parentId": { +"description": "Parent ID for this request.", +"location": "query", +"type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", +"location": "query", +"type": "boolean" +} +}, +"path": "locations/global/securityPolicies", +"response": { +"$ref": "SecurityPolicyList" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"listAssociations": { +"description": "Lists associations of a specified target, i.e., organization or folder. Use of this API to read firewall policies is deprecated. Use firewallPolicies.listAssociations instead if possible.", +"flatPath": "locations/global/securityPolicies/listAssociations", +"httpMethod": "GET", +"id": "compute.organizationSecurityPolicies.listAssociations", +"parameters": { +"targetResource": { +"description": "The target resource to list associations. It is an organization, or a folder.", +"location": "query", +"type": "string" +} +}, +"path": "locations/global/securityPolicies/listAssociations", +"response": { +"$ref": "OrganizationSecurityPoliciesListAssociationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"listPreconfiguredExpressionSets": { +"description": "Gets the current list of preconfigured Web Application Firewall (WAF) expressions.", +"flatPath": "locations/global/securityPolicies/listPreconfiguredExpressionSets", +"httpMethod": "GET", +"id": "compute.organizationSecurityPolicies.listPreconfiguredExpressionSets", +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", +"location": "query", +"type": "string" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", +"location": "query", +"type": "string" +}, +"parentId": { +"description": "Parent ID for this request.", +"location": "query", +"type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", +"location": "query", +"type": "boolean" +} +}, +"path": "locations/global/securityPolicies/listPreconfiguredExpressionSets", +"response": { +"$ref": "SecurityPoliciesListPreconfiguredExpressionSetsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"move": { +"description": "Moves the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.move instead.", +"flatPath": "locations/global/securityPolicies/{securityPolicy}/move", +"httpMethod": "POST", +"id": "compute.organizationSecurityPolicies.move", +"parameterOrder": [ +"securityPolicy" +], +"parameters": { +"parentId": { +"description": "The new parent of the security policy.", +"location": "query", +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"securityPolicy": { +"description": "Name of the security policy to update.", +"location": "path", +"pattern": "(securityPolicies/)?[0-9]{0,20}", +"required": true, +"type": "string" +} +}, +"path": "locations/global/securityPolicies/{securityPolicy}/move", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"patch": { +"description": "Patches the specified policy with the data included in the request. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.patch instead.", +"flatPath": "locations/global/securityPolicies/{securityPolicy}", +"httpMethod": "PATCH", +"id": "compute.organizationSecurityPolicies.patch", +"parameterOrder": [ +"securityPolicy" +], +"parameters": { +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"securityPolicy": { +"description": "Name of the security policy to update.", +"location": "path", +"pattern": "(securityPolicies/)?[0-9]{0,20}", +"required": true, +"type": "string" +} +}, +"path": "locations/global/securityPolicies/{securityPolicy}", +"request": { +"$ref": "SecurityPolicy" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"patchRule": { +"description": "Patches a rule at the specified priority. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.patchRule instead.", +"flatPath": "locations/global/securityPolicies/{securityPolicy}/patchRule", +"httpMethod": "POST", +"id": "compute.organizationSecurityPolicies.patchRule", +"parameterOrder": [ +"securityPolicy" +], +"parameters": { +"priority": { +"description": "The priority of the rule to patch.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"securityPolicy": { +"description": "Name of the security policy to update.", +"location": "path", +"pattern": "(securityPolicies/)?[0-9]{0,20}", +"required": true, +"type": "string" +} +}, +"path": "locations/global/securityPolicies/{securityPolicy}/patchRule", +"request": { +"$ref": "SecurityPolicyRule" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"removeAssociation": { +"description": "Removes an association for the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.removeAssociation instead if possible.", +"flatPath": "locations/global/securityPolicies/{securityPolicy}/removeAssociation", +"httpMethod": "POST", +"id": "compute.organizationSecurityPolicies.removeAssociation", +"parameterOrder": [ +"securityPolicy" +], +"parameters": { +"name": { +"description": "Name for the attachment that will be removed.", +"location": "query", +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"securityPolicy": { +"description": "Name of the security policy to update.", +"location": "path", +"pattern": "(securityPolicies/)?[0-9]{0,20}", +"required": true, +"type": "string" +} +}, +"path": "locations/global/securityPolicies/{securityPolicy}/removeAssociation", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"removeRule": { +"description": "Deletes a rule at the specified priority.", +"flatPath": "locations/global/securityPolicies/{securityPolicy}/removeRule", +"httpMethod": "POST", +"id": "compute.organizationSecurityPolicies.removeRule", +"parameterOrder": [ +"securityPolicy" +], +"parameters": { +"priority": { +"description": "The priority of the rule to remove from the security policy.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"securityPolicy": { +"description": "Name of the security policy to update.", +"location": "path", +"pattern": "(securityPolicies/)?[0-9]{0,20}", +"required": true, +"type": "string" +} +}, +"path": "locations/global/securityPolicies/{securityPolicy}/removeRule", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +} +} +}, "packetMirrorings": { "methods": { "aggregatedList": { @@ -19950,17 +20552,212 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" -}, -"serviceProjectNumber": { -"description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", -"format": "int64", -"location": "query", -"type": "string" +}, +"serviceProjectNumber": { +"description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/aggregated/packetMirrorings", +"response": { +"$ref": "PacketMirroringAggregatedList" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"delete": { +"description": "Deletes the specified PacketMirroring resource.", +"flatPath": "projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}", +"httpMethod": "DELETE", +"id": "compute.packetMirrorings.delete", +"parameterOrder": [ +"project", +"region", +"packetMirroring" +], +"parameters": { +"packetMirroring": { +"description": "Name of the PacketMirroring 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" +}, +"region": { +"description": "Name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"get": { +"description": "Returns the specified PacketMirroring resource.", +"flatPath": "projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}", +"httpMethod": "GET", +"id": "compute.packetMirrorings.get", +"parameterOrder": [ +"project", +"region", +"packetMirroring" +], +"parameters": { +"packetMirroring": { +"description": "Name of the PacketMirroring 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" +}, +"region": { +"description": "Name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}", +"response": { +"$ref": "PacketMirroring" +}, +"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 PacketMirroring resource in the specified project and region using the data included in the request.", +"flatPath": "projects/{project}/regions/{region}/packetMirrorings", +"httpMethod": "POST", +"id": "compute.packetMirrorings.insert", +"parameterOrder": [ +"project", +"region" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/packetMirrorings", +"request": { +"$ref": "PacketMirroring" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"list": { +"description": "Retrieves a list of PacketMirroring resources available to the specified project and region.", +"flatPath": "projects/{project}/regions/{region}/packetMirrorings", +"httpMethod": "GET", +"id": "compute.packetMirrorings.list", +"parameterOrder": [ +"project", +"region" +], +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", +"location": "query", +"type": "string" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", +"location": "query", +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", +"location": "query", +"type": "boolean" } }, -"path": "projects/{project}/aggregated/packetMirrorings", +"path": "projects/{project}/regions/{region}/packetMirrorings", "response": { -"$ref": "PacketMirroringAggregatedList" +"$ref": "PacketMirroringList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -19968,11 +20765,11 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, -"delete": { -"description": "Deletes the specified PacketMirroring resource.", +"patch": { +"description": "Patches the specified PacketMirroring resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.", "flatPath": "projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}", -"httpMethod": "DELETE", -"id": "compute.packetMirrorings.delete", +"httpMethod": "PATCH", +"id": "compute.packetMirrorings.patch", "parameterOrder": [ "project", "region", @@ -19980,7 +20777,7 @@ ], "parameters": { "packetMirroring": { -"description": "Name of the PacketMirroring resource to delete.", +"description": "Name of the PacketMirroring resource to patch.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -20007,6 +20804,9 @@ } }, "path": "projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}", +"request": { +"$ref": "PacketMirroring" +}, "response": { "$ref": "Operation" }, @@ -20015,24 +20815,17 @@ "https://www.googleapis.com/auth/compute" ] }, -"get": { -"description": "Returns the specified PacketMirroring resource.", -"flatPath": "projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}", -"httpMethod": "GET", -"id": "compute.packetMirrorings.get", +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified resource.", +"flatPath": "projects/{project}/regions/{region}/packetMirrorings/{resource}/testIamPermissions", +"httpMethod": "POST", +"id": "compute.packetMirrorings.testIamPermissions", "parameterOrder": [ "project", "region", -"packetMirroring" +"resource" ], "parameters": { -"packetMirroring": { -"description": "Name of the PacketMirroring 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", @@ -20041,73 +20834,79 @@ "type": "string" }, "region": { -"description": "Name of the region for this request.", +"description": "The name of the region for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" +}, +"resource": { +"description": "Name or id of the resource for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" } }, -"path": "projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}", +"path": "projects/{project}/regions/{region}/packetMirrorings/{resource}/testIamPermissions", +"request": { +"$ref": "TestPermissionsRequest" +}, "response": { -"$ref": "PacketMirroring" +"$ref": "TestPermissionsResponse" }, "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 PacketMirroring resource in the specified project and region using the data included in the request.", -"flatPath": "projects/{project}/regions/{region}/packetMirrorings", -"httpMethod": "POST", -"id": "compute.packetMirrorings.insert", +"previewFeatures": { +"methods": { +"get": { +"description": "Returns the details of the given PreviewFeature.", +"flatPath": "projects/{project}/global/previewFeatures/{previewFeature}", +"httpMethod": "GET", +"id": "compute.previewFeatures.get", "parameterOrder": [ "project", -"region" +"previewFeature" ], "parameters": { -"project": { -"description": "Project ID for this request.", +"previewFeature": { +"description": "Name of the PreviewFeature for this request.", "location": "path", -"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" }, -"region": { -"description": "Name of the region for this request.", +"project": { +"description": "Project ID for this request.", "location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "required": true, "type": "string" -}, -"requestId": { -"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", -"location": "query", -"type": "string" } }, -"path": "projects/{project}/regions/{region}/packetMirrorings", -"request": { -"$ref": "PacketMirroring" -}, +"path": "projects/{project}/global/previewFeatures/{previewFeature}", "response": { -"$ref": "Operation" +"$ref": "PreviewFeature" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute" +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" ] }, "list": { -"description": "Retrieves a list of PacketMirroring resources available to the specified project and region.", -"flatPath": "projects/{project}/regions/{region}/packetMirrorings", +"description": "Returns the details of the given PreviewFeature.", +"flatPath": "projects/{project}/global/previewFeatures", "httpMethod": "GET", -"id": "compute.packetMirrorings.list", +"id": "compute.previewFeatures.list", "parameterOrder": [ -"project", -"region" +"project" ], "parameters": { "filter": { @@ -20140,22 +20939,15 @@ "required": true, "type": "string" }, -"region": { -"description": "Name of the region for this request.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", -"required": true, -"type": "string" -}, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, -"path": "projects/{project}/regions/{region}/packetMirrorings", +"path": "projects/{project}/global/previewFeatures", "response": { -"$ref": "PacketMirroringList" +"$ref": "PreviewFeatureList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -20163,19 +20955,18 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, -"patch": { -"description": "Patches the specified PacketMirroring resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.", -"flatPath": "projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}", +"update": { +"description": "Patches the given PreviewFeature. This method is used to enable or disable a PreviewFeature.", +"flatPath": "projects/{project}/global/previewFeatures/{previewFeature}", "httpMethod": "PATCH", -"id": "compute.packetMirrorings.patch", +"id": "compute.previewFeatures.update", "parameterOrder": [ "project", -"region", -"packetMirroring" +"previewFeature" ], "parameters": { -"packetMirroring": { -"description": "Name of the PacketMirroring resource to patch.", +"previewFeature": { +"description": "Name of the PreviewFeature for this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -20188,22 +20979,15 @@ "required": true, "type": "string" }, -"region": { -"description": "Name of the region for this request.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", -"required": true, -"type": "string" -}, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, -"path": "projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}", +"path": "projects/{project}/global/previewFeatures/{previewFeature}", "request": { -"$ref": "PacketMirroring" +"$ref": "PreviewFeature" }, "response": { "$ref": "Operation" @@ -20212,52 +20996,6 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] -}, -"testIamPermissions": { -"description": "Returns permissions that a caller has on the specified resource.", -"flatPath": "projects/{project}/regions/{region}/packetMirrorings/{resource}/testIamPermissions", -"httpMethod": "POST", -"id": "compute.packetMirrorings.testIamPermissions", -"parameterOrder": [ -"project", -"region", -"resource" -], -"parameters": { -"project": { -"description": "Project ID for this request.", -"location": "path", -"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", -"required": true, -"type": "string" -}, -"region": { -"description": "The name of the region for this request.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", -"required": true, -"type": "string" -}, -"resource": { -"description": "Name or id of the resource for this request.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", -"required": true, -"type": "string" -} -}, -"path": "projects/{project}/regions/{region}/packetMirrorings/{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" -] } } }, @@ -30480,6 +31218,60 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] +}, +"reportFaulty": { +"description": "Allows customers to report a faulty subBlock.", +"flatPath": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/reportFaulty", +"httpMethod": "POST", +"id": "compute.reservationSubBlocks.reportFaulty", +"parameterOrder": [ +"project", +"zone", +"parentName", +"reservationSubBlock" +], +"parameters": { +"parentName": { +"description": "The name of the parent reservation and parent block. In the format of reservations/{reservation_name}/reservationBlocks/{reservation_block_name}", +"location": "path", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"reservationSubBlock": { +"description": "The name of the reservation subBlock. Name should conform to RFC1035 or be a resource ID.", +"location": "path", +"required": true, +"type": "string" +}, +"zone": { +"description": "Name of the zone for this request. Zone name should conform to RFC1035.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/reportFaulty", +"request": { +"$ref": "ReservationSubBlocksReportFaultyRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] } } }, @@ -40401,7 +41193,7 @@ } } }, -"revision": "20250909", +"revision": "20250916", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -46478,6 +47270,28 @@ false }, "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" +}, "DeprecationStatus": { "description": "Deprecation status for a public resource.", "id": "DeprecationStatus", @@ -52718,6 +53532,10 @@ false "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, +"params": { +"$ref": "ImageParams", +"description": "Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload." +}, "rawDisk": { "description": "The parameters of the raw disk image.", "properties": { @@ -52999,6 +53817,20 @@ false }, "type": "object" }, +"ImageParams": { +"description": "Additional image params.", +"id": "ImageParams", +"properties": { +"resourceManagerTags": { +"additionalProperties": { +"type": "string" +}, +"description": "Resource manager tags to be bound to the image. 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.", +"type": "object" +} +}, +"type": "object" +}, "InitialStateConfig": { "description": "Initial State for shielded instance, these are public keys which are safe to store in public", "id": "InitialStateConfig", @@ -58397,6 +59229,18 @@ false "The interconnect has not completed turnup. No attachments may be provisioned on this interconnect." ], "type": "string" +}, +"subzone": { +"description": "Specific subzone in the InterconnectLocation that represents where this connection is to be provisioned.", +"enum": [ +"SUBZONE_A", +"SUBZONE_B" +], +"enumDescriptions": [ +"Subzone A.", +"Subzone B." +], +"type": "string" } }, "type": "object" @@ -69868,6 +70712,24 @@ false }, "type": "object" }, +"OrganizationSecurityPoliciesListAssociationsResponse": { +"id": "OrganizationSecurityPoliciesListAssociationsResponse", +"properties": { +"associations": { +"description": "A list of associations.", +"items": { +"$ref": "SecurityPolicyAssociation" +}, +"type": "array" +}, +"kind": { +"default": "compute#organizationSecurityPoliciesListAssociationsResponse", +"description": "[Output Only] Type of securityPolicy associations. Always compute#organizationSecurityPoliciesListAssociations for lists of securityPolicy associations.", +"type": "string" +} +}, +"type": "object" +}, "OutlierDetection": { "description": "Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service.", "id": "OutlierDetection", @@ -70640,269 +71502,565 @@ false }, "type": "object" }, -"PathMatcher": { -"description": "A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service is used.", -"id": "PathMatcher", -"properties": { -"defaultCustomErrorResponsePolicy": { -"$ref": "CustomErrorResponsePolicy", -"description": "defaultCustomErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceor BackendBucket responds with an error. This policy takes effect at the PathMatcher level and applies only when no policy has been defined for the error code at lower levels like RouteRule and PathRule within this PathMatcher. If an error code does not have a policy defined in defaultCustomErrorResponsePolicy, then a policy defined for the error code in UrlMap.defaultCustomErrorResponsePolicy takes effect. For example, consider a UrlMap with the following configuration: - UrlMap.defaultCustomErrorResponsePolicy is configured with policies for 5xx and 4xx errors - A RouteRule for /coming_soon/ is configured for the error code 404. If the request is for www.myotherdomain.com and a 404 is encountered, the policy under UrlMap.defaultCustomErrorResponsePolicy takes effect. If a 404 response is encountered for the request www.example.com/current_events/, the pathMatcher's policy takes effect. If however, the request for www.example.com/coming_soon/ encounters a 404, the policy in RouteRule.customErrorResponsePolicy takes effect. If any of the requests in this example encounter a 500 error code, the policy at UrlMap.defaultCustomErrorResponsePolicy takes effect. When used in conjunction with pathMatcher.defaultRouteAction.retryPolicy, retries take precedence. Only once all retries are exhausted, the defaultCustomErrorResponsePolicy is applied. While attempting a retry, if load balancer is successful in reaching the service, the defaultCustomErrorResponsePolicy is ignored and the response from the service is returned to the client. defaultCustomErrorResponsePolicy is supported only for global external Application Load Balancers." -}, -"defaultRouteAction": { -"$ref": "HttpRouteAction", -"description": "defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction." -}, -"defaultService": { -"description": "The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use ", -"type": "string" -}, -"defaultUrlRedirect": { -"$ref": "HttpRedirectAction", -"description": "When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set. Not supported when the URL map is bound to a target gRPC proxy." -}, -"description": { -"description": "An optional description of this resource. Provide this property when you create the resource.", -"type": "string" -}, -"headerAction": { -"$ref": "HttpHeaderAction", -"description": "Specifies changes to request and response headers that need to take effect for the selected backend service. HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap HeaderAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true." -}, -"name": { -"description": "The name to which this PathMatcher is referred by the HostRule.", -"type": "string" -}, -"pathRules": { -"description": "The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis. For example: a pathRule with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list. Within a given pathMatcher, only one of pathRules or routeRules must be set.", -"items": { -"$ref": "PathRule" -}, -"type": "array" -}, -"routeRules": { -"description": "The list of HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. routeRules are evaluated in order of priority, from the lowest to highest number. Within a given pathMatcher, you can set only one of pathRules or routeRules.", -"items": { -"$ref": "HttpRouteRule" -}, -"type": "array" -} -}, -"type": "object" -}, -"PathRule": { -"description": "A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.", -"id": "PathRule", +"PathMatcher": { +"description": "A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service is used.", +"id": "PathMatcher", +"properties": { +"defaultCustomErrorResponsePolicy": { +"$ref": "CustomErrorResponsePolicy", +"description": "defaultCustomErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceor BackendBucket responds with an error. This policy takes effect at the PathMatcher level and applies only when no policy has been defined for the error code at lower levels like RouteRule and PathRule within this PathMatcher. If an error code does not have a policy defined in defaultCustomErrorResponsePolicy, then a policy defined for the error code in UrlMap.defaultCustomErrorResponsePolicy takes effect. For example, consider a UrlMap with the following configuration: - UrlMap.defaultCustomErrorResponsePolicy is configured with policies for 5xx and 4xx errors - A RouteRule for /coming_soon/ is configured for the error code 404. If the request is for www.myotherdomain.com and a 404 is encountered, the policy under UrlMap.defaultCustomErrorResponsePolicy takes effect. If a 404 response is encountered for the request www.example.com/current_events/, the pathMatcher's policy takes effect. If however, the request for www.example.com/coming_soon/ encounters a 404, the policy in RouteRule.customErrorResponsePolicy takes effect. If any of the requests in this example encounter a 500 error code, the policy at UrlMap.defaultCustomErrorResponsePolicy takes effect. When used in conjunction with pathMatcher.defaultRouteAction.retryPolicy, retries take precedence. Only once all retries are exhausted, the defaultCustomErrorResponsePolicy is applied. While attempting a retry, if load balancer is successful in reaching the service, the defaultCustomErrorResponsePolicy is ignored and the response from the service is returned to the client. defaultCustomErrorResponsePolicy is supported only for global external Application Load Balancers." +}, +"defaultRouteAction": { +"$ref": "HttpRouteAction", +"description": "defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction." +}, +"defaultService": { +"description": "The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use ", +"type": "string" +}, +"defaultUrlRedirect": { +"$ref": "HttpRedirectAction", +"description": "When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set. Not supported when the URL map is bound to a target gRPC proxy." +}, +"description": { +"description": "An optional description of this resource. Provide this property when you create the resource.", +"type": "string" +}, +"headerAction": { +"$ref": "HttpHeaderAction", +"description": "Specifies changes to request and response headers that need to take effect for the selected backend service. HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap HeaderAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true." +}, +"name": { +"description": "The name to which this PathMatcher is referred by the HostRule.", +"type": "string" +}, +"pathRules": { +"description": "The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis. For example: a pathRule with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list. Within a given pathMatcher, only one of pathRules or routeRules must be set.", +"items": { +"$ref": "PathRule" +}, +"type": "array" +}, +"routeRules": { +"description": "The list of HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. routeRules are evaluated in order of priority, from the lowest to highest number. Within a given pathMatcher, you can set only one of pathRules or routeRules.", +"items": { +"$ref": "HttpRouteRule" +}, +"type": "array" +} +}, +"type": "object" +}, +"PathRule": { +"description": "A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.", +"id": "PathRule", +"properties": { +"customErrorResponsePolicy": { +"$ref": "CustomErrorResponsePolicy", +"description": "customErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceor BackendBucket responds with an error. If a policy for an error code is not configured for the PathRule, a policy for the error code configured in pathMatcher.defaultCustomErrorResponsePolicy is applied. If one is not specified in pathMatcher.defaultCustomErrorResponsePolicy, the policy configured in UrlMap.defaultCustomErrorResponsePolicy takes effect. For example, consider a UrlMap with the following configuration: - UrlMap.defaultCustomErrorResponsePolicy are configured with policies for 5xx and 4xx errors - A PathRule for /coming_soon/ is configured for the error code 404. If the request is for www.myotherdomain.com and a 404 is encountered, the policy under UrlMap.defaultCustomErrorResponsePolicy takes effect. If a 404 response is encountered for the request www.example.com/current_events/, the pathMatcher's policy takes effect. If however, the request for www.example.com/coming_soon/ encounters a 404, the policy in PathRule.customErrorResponsePolicy takes effect. If any of the requests in this example encounter a 500 error code, the policy at UrlMap.defaultCustomErrorResponsePolicy takes effect. customErrorResponsePolicy is supported only for global external Application Load Balancers." +}, +"paths": { +"description": "The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.", +"items": { +"type": "string" +}, +"type": "array" +}, +"routeAction": { +"$ref": "HttpRouteAction", +"description": "In response to a matching path, the load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. Only one of urlRedirect, service or routeAction.weightedBackendService can be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path rule's routeAction." +}, +"service": { +"description": "The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. Only one of urlRedirect, service or routeAction.weightedBackendService can be set.", +"type": "string" +}, +"urlRedirect": { +"$ref": "HttpRedirectAction", +"description": "When a path pattern is matched, the request is redirected to a URL specified by urlRedirect. Only one of urlRedirect, service or routeAction.weightedBackendService can be set. Not supported when the URL map is bound to a target gRPC proxy." +} +}, +"type": "object" +}, +"PerInstanceConfig": { +"id": "PerInstanceConfig", +"properties": { +"fingerprint": { +"description": "Fingerprint of this per-instance config. This field can be used in optimistic locking. It is ignored when inserting a per-instance config. An up-to-date fingerprint must be provided in order to update an existing per-instance configuration or the field needs to be unset.", +"format": "byte", +"type": "string" +}, +"name": { +"description": "The name of a per-instance configuration and its corresponding instance. Serves as a merge key during UpdatePerInstanceConfigs operations, that is, if a per-instance configuration with the same name exists then it will be updated, otherwise a new one will be created for the VM instance with the same name. An attempt to create a per-instance configuration for a VM instance that either doesn't exist or is not part of the group will result in an error.", +"type": "string" +}, +"preservedState": { +"$ref": "PreservedState", +"description": "The intended preserved state for the given instance. Does not contain preserved state generated from a stateful policy." +}, +"status": { +"description": "The status of applying this per-instance configuration on the corresponding managed instance.", +"enum": [ +"APPLYING", +"DELETING", +"EFFECTIVE", +"NONE", +"UNAPPLIED", +"UNAPPLIED_DELETION" +], +"enumDescriptions": [ +"The per-instance configuration is being applied to the instance, but is not yet effective, possibly waiting for the instance to, for example, REFRESH.", +"The per-instance configuration deletion is being applied on the instance, possibly waiting for the instance to, for example, REFRESH.", +"The per-instance configuration is effective on the instance, meaning that all disks, ips and metadata specified in this configuration are attached or set on the instance.", +"*[Default]* The default status, when no per-instance configuration exists.", +"The per-instance configuration is set on an instance but not been applied yet.", +"The per-instance configuration has been deleted, but the deletion is not yet applied." +], +"type": "string" +} +}, +"type": "object" +}, +"Policy": { +"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).", +"id": "Policy", +"properties": { +"auditConfigs": { +"description": "Specifies cloud audit logging configuration for this policy.", +"items": { +"$ref": "AuditConfig" +}, +"type": "array" +}, +"bindings": { +"description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.", +"items": { +"$ref": "Binding" +}, +"type": "array" +}, +"etag": { +"description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.", +"format": "byte", +"type": "string" +}, +"version": { +"description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"PreconfiguredWafSet": { +"id": "PreconfiguredWafSet", +"properties": { +"expressionSets": { +"description": "List of entities that are currently supported for WAF rules.", +"items": { +"$ref": "WafExpressionSet" +}, +"type": "array" +} +}, +"type": "object" +}, +"PreservedState": { +"description": "Preserved state for a given instance.", +"id": "PreservedState", +"properties": { +"disks": { +"additionalProperties": { +"$ref": "PreservedStatePreservedDisk" +}, +"description": "Preserved disks defined for this instance. This map is keyed with the device names of the disks.", +"type": "object" +}, +"externalIPs": { +"additionalProperties": { +"$ref": "PreservedStatePreservedNetworkIp" +}, +"description": "Preserved external IPs defined for this instance. This map is keyed with the name of the network interface.", +"type": "object" +}, +"internalIPs": { +"additionalProperties": { +"$ref": "PreservedStatePreservedNetworkIp" +}, +"description": "Preserved internal IPs defined for this instance. This map is keyed with the name of the network interface.", +"type": "object" +}, +"metadata": { +"additionalProperties": { +"type": "string" +}, +"description": "Preserved metadata defined for this instance.", +"type": "object" +} +}, +"type": "object" +}, +"PreservedStatePreservedDisk": { +"id": "PreservedStatePreservedDisk", +"properties": { +"autoDelete": { +"description": "These stateful disks will never be deleted during autohealing, update, instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole MIG is deleted. Note: disks attached in READ_ONLY mode cannot be auto-deleted.", +"enum": [ +"NEVER", +"ON_PERMANENT_INSTANCE_DELETION" +], +"enumDescriptions": [ +"", +"" +], +"type": "string" +}, +"mode": { +"description": "The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.", +"enum": [ +"READ_ONLY", +"READ_WRITE" +], +"enumDescriptions": [ +"Attaches this disk in read-only mode. Multiple VM instances can use a disk in READ_ONLY mode at a time.", +"*[Default]* Attaches this disk in READ_WRITE mode. Only one VM instance at a time can be attached to a disk in READ_WRITE mode." +], +"type": "string" +}, +"source": { +"description": "The URL of the disk resource that is stateful and should be attached to the VM instance.", +"type": "string" +} +}, +"type": "object" +}, +"PreservedStatePreservedNetworkIp": { +"id": "PreservedStatePreservedNetworkIp", +"properties": { +"autoDelete": { +"description": "These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted.", +"enum": [ +"NEVER", +"ON_PERMANENT_INSTANCE_DELETION" +], +"enumDescriptions": [ +"", +"" +], +"type": "string" +}, +"ipAddress": { +"$ref": "PreservedStatePreservedNetworkIpIpAddress", +"description": "Ip address representation" +} +}, +"type": "object" +}, +"PreservedStatePreservedNetworkIpIpAddress": { +"id": "PreservedStatePreservedNetworkIpIpAddress", +"properties": { +"address": { +"description": "The URL of the reservation for this IP address.", +"type": "string" +}, +"literal": { +"description": "An IPv4 internal network address to assign to the instance for this network interface.", +"type": "string" +} +}, +"type": "object" +}, +"PreviewFeature": { +"description": "Represents a single Google Compute Engine preview feature.", +"id": "PreviewFeature", +"properties": { +"activationStatus": { +"description": "Specifies whether the feature is enabled or disabled.", +"enum": [ +"ACTIVATION_STATE_UNSPECIFIED", +"DISABLED", +"ENABLED" +], +"enumDescriptions": [ +"", +"", +"" +], +"type": "string" +}, +"creationTimestamp": { +"description": "[Output Only] Creation timestamp in RFC3339 text format.", +"type": "string" +}, +"description": { +"description": "[Output Only] Description of the feature.", +"type": "string" +}, +"id": { +"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", +"format": "uint64", +"type": "string" +}, +"kind": { +"default": "compute#previewFeature", +"description": "[Output only] The type of the feature. Always \"compute#previewFeature\" for preview features.", +"type": "string" +}, +"name": { +"description": "Name of the feature.", +"type": "string" +}, +"rolloutOperation": { +"$ref": "PreviewFeatureRolloutOperation", +"description": "Rollout operation of the feature." +}, +"selfLink": { +"description": "[Output Only] Server-defined URL for the resource.", +"type": "string" +}, +"status": { +"$ref": "PreviewFeatureStatus", +"description": "[Output only] Status of the feature." +} +}, +"type": "object" +}, +"PreviewFeatureList": { +"id": "PreviewFeatureList", +"properties": { +"etag": { +"type": "string" +}, +"id": { +"description": "[Output Only] Unique identifier for the resource; defined by the server.", +"type": "string" +}, +"items": { +"description": "A list of PreviewFeature resources.", +"items": { +"$ref": "PreviewFeature" +}, +"type": "array" +}, +"nextPageToken": { +"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", +"type": "string" +}, +"selfLink": { +"description": "[Output Only] Server-defined URL for this resource.", +"type": "string" +}, +"unreachables": { +"description": "[Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder", +"items": { +"type": "string" +}, +"type": "array" +}, +"warning": { +"description": "[Output Only] Informational warning message.", +"properties": { +"code": { +"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", +"enum": [ +"CLEANUP_FAILED", +"DEPRECATED_RESOURCE_USED", +"DEPRECATED_TYPE_USED", +"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", +"EXPERIMENTAL_TYPE_USED", +"EXTERNAL_API_WARNING", +"FIELD_VALUE_OVERRIDEN", +"INJECTED_KERNELS_DEPRECATED", +"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", +"LARGE_DEPLOYMENT_WARNING", +"LIST_OVERHEAD_QUOTA_EXCEED", +"MISSING_TYPE_DEPENDENCY", +"NEXT_HOP_ADDRESS_NOT_ASSIGNED", +"NEXT_HOP_CANNOT_IP_FORWARD", +"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", +"NEXT_HOP_INSTANCE_NOT_FOUND", +"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", +"NEXT_HOP_NOT_RUNNING", +"NOT_CRITICAL_ERROR", +"NO_RESULTS_ON_PAGE", +"PARTIAL_SUCCESS", +"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 operation.", +"A link to a deprecated resource was created.", +"When deploying and at least one of the resources has a type marked as deprecated", +"The user created a boot disk that is larger than image size.", +"When deploying and at least one of the resources has a type marked as experimental", +"Warning that is present in an external api call", +"Warning that value of a field has been overridden. Deprecated unused field.", +"The operation involved use of an injected kernel, which is deprecated.", +"A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", +"When deploying a deployment with a exceedingly large number of resources", +"Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", +"A resource depends on a missing type", +"The route's nextHopIp address is not assigned to an instance on the network.", +"The route's next hop instance cannot ip forward.", +"The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", +"The route's nextHopInstance URL refers to an instance that does not exist.", +"The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", +"The route's next hop instance does not have a status of RUNNING.", +"Error which is not critical. We decided to continue the process despite the mentioned error.", +"No results are present on a particular list page.", +"Success is reported, but some results may be missing due to errors", +"Quota information is not available to client requests (e.g: regions.list).", +"The user attempted to use a resource that requires a TOS they have not accepted.", +"Warning that a resource is in use.", +"One or more of the resources set to auto-delete could not be deleted because they were in use.", +"When a resource schema validation is ignored.", +"Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", +"When undeclared properties in the schema are present", +"A given scope cannot be reached." +], +"type": "string" +}, +"data": { +"description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", +"type": "string" +}, +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "[Output Only] A human-readable description of the warning code.", +"type": "string" +} +}, +"type": "object" +} +}, +"type": "object" +}, +"PreviewFeatureRolloutOperation": { +"description": "Represents the rollout operation", +"id": "PreviewFeatureRolloutOperation", "properties": { -"customErrorResponsePolicy": { -"$ref": "CustomErrorResponsePolicy", -"description": "customErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceor BackendBucket responds with an error. If a policy for an error code is not configured for the PathRule, a policy for the error code configured in pathMatcher.defaultCustomErrorResponsePolicy is applied. If one is not specified in pathMatcher.defaultCustomErrorResponsePolicy, the policy configured in UrlMap.defaultCustomErrorResponsePolicy takes effect. For example, consider a UrlMap with the following configuration: - UrlMap.defaultCustomErrorResponsePolicy are configured with policies for 5xx and 4xx errors - A PathRule for /coming_soon/ is configured for the error code 404. If the request is for www.myotherdomain.com and a 404 is encountered, the policy under UrlMap.defaultCustomErrorResponsePolicy takes effect. If a 404 response is encountered for the request www.example.com/current_events/, the pathMatcher's policy takes effect. If however, the request for www.example.com/coming_soon/ encounters a 404, the policy in PathRule.customErrorResponsePolicy takes effect. If any of the requests in this example encounter a 500 error code, the policy at UrlMap.defaultCustomErrorResponsePolicy takes effect. customErrorResponsePolicy is supported only for global external Application Load Balancers." -}, -"paths": { -"description": "The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.", -"items": { -"type": "string" -}, -"type": "array" -}, -"routeAction": { -"$ref": "HttpRouteAction", -"description": "In response to a matching path, the load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. Only one of urlRedirect, service or routeAction.weightedBackendService can be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path rule's routeAction." -}, -"service": { -"description": "The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. Only one of urlRedirect, service or routeAction.weightedBackendService can be set.", -"type": "string" -}, -"urlRedirect": { -"$ref": "HttpRedirectAction", -"description": "When a path pattern is matched, the request is redirected to a URL specified by urlRedirect. Only one of urlRedirect, service or routeAction.weightedBackendService can be set. Not supported when the URL map is bound to a target gRPC proxy." +"rolloutInput": { +"$ref": "PreviewFeatureRolloutOperationRolloutInput", +"description": "Input only. The input for the rollout operation." } }, "type": "object" }, -"PerInstanceConfig": { -"id": "PerInstanceConfig", +"PreviewFeatureRolloutOperationRolloutInput": { +"description": "Represents the input for the rollout operation.", +"id": "PreviewFeatureRolloutOperationRolloutInput", "properties": { -"fingerprint": { -"description": "Fingerprint of this per-instance config. This field can be used in optimistic locking. It is ignored when inserting a per-instance config. An up-to-date fingerprint must be provided in order to update an existing per-instance configuration or the field needs to be unset.", -"format": "byte", -"type": "string" -}, "name": { -"description": "The name of a per-instance configuration and its corresponding instance. Serves as a merge key during UpdatePerInstanceConfigs operations, that is, if a per-instance configuration with the same name exists then it will be updated, otherwise a new one will be created for the VM instance with the same name. An attempt to create a per-instance configuration for a VM instance that either doesn't exist or is not part of the group will result in an error.", +"description": "The name of the rollout plan Ex. organizations//locations/global/rolloutPlans/ Ex. folders//locations/global/rolloutPlans/ Ex. projects//locations/global/rolloutPlans/.", "type": "string" }, -"preservedState": { -"$ref": "PreservedState", -"description": "The intended preserved state for the given instance. Does not contain preserved state generated from a stateful policy." -}, -"status": { -"description": "The status of applying this per-instance configuration on the corresponding managed instance.", +"predefinedRolloutPlan": { +"description": "Predefined rollout plan.", "enum": [ -"APPLYING", -"DELETING", -"EFFECTIVE", -"NONE", -"UNAPPLIED", -"UNAPPLIED_DELETION" +"ROLLOUT_PLAN_FAST_ROLLOUT", +"ROLLOUT_PLAN_TWO_DAY_ROLLOUT", +"ROLLOUT_PLAN_UNSPECIFIED" ], "enumDescriptions": [ -"The per-instance configuration is being applied to the instance, but is not yet effective, possibly waiting for the instance to, for example, REFRESH.", -"The per-instance configuration deletion is being applied on the instance, possibly waiting for the instance to, for example, REFRESH.", -"The per-instance configuration is effective on the instance, meaning that all disks, ips and metadata specified in this configuration are attached or set on the instance.", -"*[Default]* The default status, when no per-instance configuration exists.", -"The per-instance configuration is set on an instance but not been applied yet.", -"The per-instance configuration has been deleted, but the deletion is not yet applied." +"", +"", +"" ], "type": "string" } }, "type": "object" }, -"Policy": { -"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).", -"id": "Policy", +"PreviewFeatureStatus": { +"description": "[Output Only] The status of the feature.", +"id": "PreviewFeatureStatus", "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", +"description": { +"description": "[Output Only] The description of the feature.", "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" -}, -"PreconfiguredWafSet": { -"id": "PreconfiguredWafSet", -"properties": { -"expressionSets": { -"description": "List of entities that are currently supported for WAF rules.", -"items": { -"$ref": "WafExpressionSet" -}, -"type": "array" -} -}, -"type": "object" -}, -"PreservedState": { -"description": "Preserved state for a given instance.", -"id": "PreservedState", -"properties": { -"disks": { -"additionalProperties": { -"$ref": "PreservedStatePreservedDisk" -}, -"description": "Preserved disks defined for this instance. This map is keyed with the device names of the disks.", -"type": "object" -}, -"externalIPs": { -"additionalProperties": { -"$ref": "PreservedStatePreservedNetworkIp" -}, -"description": "Preserved external IPs defined for this instance. This map is keyed with the name of the network interface.", -"type": "object" -}, -"internalIPs": { -"additionalProperties": { -"$ref": "PreservedStatePreservedNetworkIp" -}, -"description": "Preserved internal IPs defined for this instance. This map is keyed with the name of the network interface.", -"type": "object" -}, -"metadata": { -"additionalProperties": { +"helpLink": { +"description": "[Output Only] Link to the public documentation for the feature.", "type": "string" }, -"description": "Preserved metadata defined for this instance.", -"type": "object" +"releaseStatus": { +"$ref": "PreviewFeatureStatusReleaseStatus" } }, "type": "object" }, -"PreservedStatePreservedDisk": { -"id": "PreservedStatePreservedDisk", +"PreviewFeatureStatusReleaseStatus": { +"description": "[Output Only] The release status of the feature.", +"id": "PreviewFeatureStatusReleaseStatus", "properties": { -"autoDelete": { -"description": "These stateful disks will never be deleted during autohealing, update, instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole MIG is deleted. Note: disks attached in READ_ONLY mode cannot be auto-deleted.", +"stage": { +"description": "[Output Only] The stage of the feature.", "enum": [ -"NEVER", -"ON_PERMANENT_INSTANCE_DELETION" +"DEPRECATED", +"GA", +"PREVIEW", +"STAGE_UNSPECIFIED" ], "enumDescriptions": [ "", -"" -], -"type": "string" -}, -"mode": { -"description": "The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.", -"enum": [ -"READ_ONLY", -"READ_WRITE" -], -"enumDescriptions": [ -"Attaches this disk in read-only mode. Multiple VM instances can use a disk in READ_ONLY mode at a time.", -"*[Default]* Attaches this disk in READ_WRITE mode. Only one VM instance at a time can be attached to a disk in READ_WRITE mode." -], -"type": "string" -}, -"source": { -"description": "The URL of the disk resource that is stateful and should be attached to the VM instance.", -"type": "string" -} -}, -"type": "object" -}, -"PreservedStatePreservedNetworkIp": { -"id": "PreservedStatePreservedNetworkIp", -"properties": { -"autoDelete": { -"description": "These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted.", -"enum": [ -"NEVER", -"ON_PERMANENT_INSTANCE_DELETION" -], -"enumDescriptions": [ +"", "", "" ], "type": "string" }, -"ipAddress": { -"$ref": "PreservedStatePreservedNetworkIpIpAddress", -"description": "Ip address representation" -} -}, -"type": "object" -}, -"PreservedStatePreservedNetworkIpIpAddress": { -"id": "PreservedStatePreservedNetworkIpIpAddress", -"properties": { -"address": { -"description": "The URL of the reservation for this IP address.", -"type": "string" -}, -"literal": { -"description": "An IPv4 internal network address to assign to the instance for this network interface.", -"type": "string" +"updateDate": { +"$ref": "Date", +"description": "Output only. The last date when a feature transitioned between ReleaseStatuses.", +"readOnly": true } }, "type": "object" @@ -75439,6 +76597,72 @@ false }, "type": "object" }, +"ReservationSubBlocksReportFaultyRequest": { +"id": "ReservationSubBlocksReportFaultyRequest", +"properties": { +"disruptionSchedule": { +"description": "The disruption schedule for the subBlock.", +"enum": [ +"DISRUPTION_SCHEDULE_UNSPECIFIED", +"IMMEDIATE" +], +"enumDescriptions": [ +"", +"All VMs will be disrupted immediately." +], +"type": "string" +}, +"failureComponent": { +"description": "The component that experienced the fault.", +"enum": [ +"FAILURE_COMPONENT_UNSPECIFIED", +"MULTIPLE_FAULTY_HOSTS", +"NVLINK_SWITCH" +], +"enumDescriptions": [ +"", +"Multiple hosts experienced the fault.", +"The NVLink switch experienced the fault." +], +"type": "string" +}, +"faultReasons": { +"description": "The reasons for the fault experienced with the subBlock.", +"items": { +"$ref": "ReservationSubBlocksReportFaultyRequestFaultReason" +}, +"type": "array" +} +}, +"type": "object" +}, +"ReservationSubBlocksReportFaultyRequestFaultReason": { +"description": "The reason for the fault experienced with the subBlock.", +"id": "ReservationSubBlocksReportFaultyRequestFaultReason", +"properties": { +"behavior": { +"description": "The behavior of the fault experienced with the subBlock.", +"enum": [ +"FAULT_BEHAVIOR_UNSPECIFIED", +"GPU_ERROR", +"PERFORMANCE", +"SWITCH_FAILURE" +], +"enumDescriptions": [ +"", +"The subBlock experienced a GPU error.", +"The subBlock experienced performance issues.", +"The subBlock experienced a switch failure." +], +"type": "string" +}, +"description": { +"description": "The description of the fault experienced with the subBlock.", +"type": "string" +} +}, +"type": "object" +}, "ReservationsBlocksPerformMaintenanceRequest": { "id": "ReservationsBlocksPerformMaintenanceRequest", "properties": { @@ -79761,6 +80985,13 @@ false "advancedOptionsConfig": { "$ref": "SecurityPolicyAdvancedOptionsConfig" }, +"associations": { +"description": "A list of associations that belong to this policy.", +"items": { +"$ref": "SecurityPolicyAssociation" +}, +"type": "array" +}, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" @@ -79822,6 +81053,11 @@ false "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, +"shortName": { +"description": "User-provided name of the organization security policy. The name should be unique in the organization in which the security policy is created. This should only be used when SecurityPolicyType is CLOUD_ARMOR. The name must be 1-63 characters long, and comply with https://www.ietf.org/rfc/rfc1035.txt. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"type": "string" +}, "type": { "description": "The type indicates the intended use of the security policy. - CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers. - CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache. - CLOUD_ARMOR_INTERNAL_SERVICE (preview only): Cloud Armor internal service policies can be configured to filter HTTP requests targeting services managed by Traffic Director in a service mesh. They filter requests before the request is served from the application. - CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application. This field can be set only at resource creation time.", "enum": [ @@ -80016,6 +81252,47 @@ false }, "type": "object" }, +"SecurityPolicyAssociation": { +"id": "SecurityPolicyAssociation", +"properties": { +"attachmentId": { +"description": "The resource that the security policy is attached to.", +"type": "string" +}, +"displayName": { +"deprecated": true, +"description": "[Output Only] The display name of the security policy of the association.", +"type": "string" +}, +"excludedFolders": { +"description": "A list of folders to exclude from the security policy.", +"items": { +"type": "string" +}, +"type": "array" +}, +"excludedProjects": { +"description": "A list of projects to exclude from the security policy.", +"items": { +"type": "string" +}, +"type": "array" +}, +"name": { +"description": "The name for an association.", +"type": "string" +}, +"securityPolicyId": { +"description": "[Output Only] The security policy ID of the association.", +"type": "string" +}, +"shortName": { +"description": "[Output Only] The short name of the security policy of the association.", +"type": "string" +} +}, +"type": "object" +}, "SecurityPolicyDdosProtectionConfig": { "id": "SecurityPolicyDdosProtectionConfig", "properties": { @@ -81627,7 +82904,7 @@ false "type": "object" }, "Snapshot": { -"description": "Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. LINT.IfChange", +"description": "Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots.", "id": "Snapshot", "properties": { "architecture": { @@ -81742,6 +83019,10 @@ false "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, +"params": { +"$ref": "SnapshotParams", +"description": "Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload." +}, "satisfiesPzi": { "description": "Output only. Reserved for future use.", "readOnly": true, @@ -82007,6 +83288,20 @@ false }, "type": "object" }, +"SnapshotParams": { +"description": "Additional snapshot params.", +"id": "SnapshotParams", +"properties": { +"resourceManagerTags": { +"additionalProperties": { +"type": "string" +}, +"description": "Resource manager tags to be bound to the snapshot. 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.", +"type": "object" +} +}, +"type": "object" +}, "SnapshotSettings": { "id": "SnapshotSettings", "properties": { From 875ca98176ebe365aab1378c1b42ba2cc6433989 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 30 Sep 2025 07:09:35 +0000 Subject: [PATCH 12/42] feat(contactcenterinsights): update the api #### contactcenterinsights:v1 The following keys were added: - resources.projects.resources.locations.resources.authorizedViewSets.resources.authorizedViews.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - resources.projects.resources.locations.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo.properties.deploymentDisplayName.type (Total Keys: 1) - schemas.GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo.properties.deploymentId.type (Total Keys: 1) - schemas.GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo.properties.versionDisplayName.type (Total Keys: 1) - schemas.GoogleCloudContactcenterinsightsV1ConversationQualityMetadataAgentInfo.properties.versionId.type (Total Keys: 1) - schemas.GoogleCloudContactcenterinsightsV1Dimension.properties.qaScorecardDimensionMetadata (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1DimensionAgentDimensionMetadata.properties.agentDeploymentDisplayName.type (Total Keys: 1) - schemas.GoogleCloudContactcenterinsightsV1DimensionAgentDimensionMetadata.properties.agentDeploymentId.type (Total Keys: 1) - schemas.GoogleCloudContactcenterinsightsV1DimensionAgentDimensionMetadata.properties.agentVersionDisplayName.type (Total Keys: 1) - schemas.GoogleCloudContactcenterinsightsV1DimensionAgentDimensionMetadata.properties.agentVersionId.type (Total Keys: 1) - schemas.GoogleCloudContactcenterinsightsV1DimensionQaScorecardDimensionMetadata (Total Keys: 3) - schemas.GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue.properties.rationale (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1QaAnswerAnswerValueQaAnswerRationale (Total Keys: 3) - schemas.GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo.properties.deploymentDisplayName.type (Total Keys: 1) - schemas.GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo.properties.deploymentId.type (Total Keys: 1) - schemas.GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo.properties.versionDisplayName.type (Total Keys: 1) - schemas.GoogleCloudContactcenterinsightsV1alpha1ConversationQualityMetadataAgentInfo.properties.versionId.type (Total Keys: 1) - schemas.GoogleCloudContactcenterinsightsV1alpha1Dimension.properties.qaScorecardDimensionMetadata (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1DimensionAgentDimensionMetadata.properties.agentDeploymentDisplayName.type (Total Keys: 1) - schemas.GoogleCloudContactcenterinsightsV1alpha1DimensionAgentDimensionMetadata.properties.agentDeploymentId.type (Total Keys: 1) - schemas.GoogleCloudContactcenterinsightsV1alpha1DimensionAgentDimensionMetadata.properties.agentVersionDisplayName.type (Total Keys: 1) - schemas.GoogleCloudContactcenterinsightsV1alpha1DimensionAgentDimensionMetadata.properties.agentVersionId.type (Total Keys: 1) - schemas.GoogleCloudContactcenterinsightsV1alpha1DimensionQaScorecardDimensionMetadata (Total Keys: 3) - schemas.GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue.properties.rationale (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValueQaAnswerRationale (Total Keys: 3) - schemas.GoogleLongrunningListOperationsResponse.properties.unreachable (Total Keys: 2) --- ...uthorizedViews.conversations.analyses.html | 18 ++ ...orizedViews.conversations.assessments.html | 28 +++ ...zedViews.conversations.feedbackLabels.html | 18 ++ ...iewSets.authorizedViews.conversations.html | 26 +++ ...ns.authorizedViewSets.authorizedViews.html | 11 +- ...edViewSets.authorizedViews.operations.html | 8 +- ...ects.locations.conversations.analyses.html | 18 ++ ...s.locations.conversations.assessments.html | 28 +++ ...ocations.conversations.feedbackLabels.html | 18 ++ ...s_v1.projects.locations.conversations.html | 91 +++++++++ ...tions.datasets.conversations.analyses.html | 18 ++ ...datasets.conversations.feedbackLabels.html | 18 ++ ...ects.locations.datasets.conversations.html | 26 +++ ...sights_v1.projects.locations.datasets.html | 3 + ...tcenterinsights_v1.projects.locations.html | 14 +- ...ghts_v1.projects.locations.operations.html | 8 +- .../documents/contactcenterinsights.v1.json | 179 ++++++++++++++++-- 17 files changed, 509 insertions(+), 21 deletions(-) diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.analyses.html b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.analyses.html index 41aa34170ef..c04ae67b126 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.analyses.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.analyses.html @@ -210,6 +210,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -224,6 +227,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -478,6 +484,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -492,6 +501,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -705,6 +717,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -719,6 +734,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.html b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.html index 5f8c357016a..7202330ee62 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.html @@ -131,6 +131,8 @@

Method Details

"agentInfo": { # Information about an agent involved in the conversation. # Information about the agent the assessment is for. "agentId": "A String", # A user-specified string representing the agent. "agentType": "A String", # The agent type, e.g. HUMAN_AGENT. + "deploymentDisplayName": "A String", # The agent's deployment display name. Only applicable to automated agents. + "deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents. "displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. "location": "A String", # The agent's location. @@ -138,6 +140,8 @@

Method Details

"teams": [ # User-specified strings representing the agent's teams. "A String", ], + "versionDisplayName": "A String", # The agent's version display name. Only applicable to automated agents. + "versionId": "A String", # The agent's version ID. Only applicable to automated agents. }, "createTime": "A String", # Output only. The time at which the assessment was created. "name": "A String", # Identifier. The resource name of the assessment. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment} @@ -164,6 +168,8 @@

Method Details

"agentInfo": { # Information about an agent involved in the conversation. # Information about the agent the assessment is for. "agentId": "A String", # A user-specified string representing the agent. "agentType": "A String", # The agent type, e.g. HUMAN_AGENT. + "deploymentDisplayName": "A String", # The agent's deployment display name. Only applicable to automated agents. + "deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents. "displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. "location": "A String", # The agent's location. @@ -171,6 +177,8 @@

Method Details

"teams": [ # User-specified strings representing the agent's teams. "A String", ], + "versionDisplayName": "A String", # The agent's version display name. Only applicable to automated agents. + "versionId": "A String", # The agent's version ID. Only applicable to automated agents. }, "createTime": "A String", # Output only. The time at which the assessment was created. "name": "A String", # Identifier. The resource name of the assessment. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment} @@ -190,6 +198,8 @@

Method Details

"agentInfo": { # Information about an agent involved in the conversation. # Information about the agent the assessment is for. "agentId": "A String", # A user-specified string representing the agent. "agentType": "A String", # The agent type, e.g. HUMAN_AGENT. + "deploymentDisplayName": "A String", # The agent's deployment display name. Only applicable to automated agents. + "deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents. "displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. "location": "A String", # The agent's location. @@ -197,6 +207,8 @@

Method Details

"teams": [ # User-specified strings representing the agent's teams. "A String", ], + "versionDisplayName": "A String", # The agent's version display name. Only applicable to automated agents. + "versionId": "A String", # The agent's version ID. Only applicable to automated agents. }, "createTime": "A String", # Output only. The time at which the assessment was created. "name": "A String", # Identifier. The resource name of the assessment. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment} @@ -248,6 +260,8 @@

Method Details

"agentInfo": { # Information about an agent involved in the conversation. # Information about the agent the assessment is for. "agentId": "A String", # A user-specified string representing the agent. "agentType": "A String", # The agent type, e.g. HUMAN_AGENT. + "deploymentDisplayName": "A String", # The agent's deployment display name. Only applicable to automated agents. + "deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents. "displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. "location": "A String", # The agent's location. @@ -255,6 +269,8 @@

Method Details

"teams": [ # User-specified strings representing the agent's teams. "A String", ], + "versionDisplayName": "A String", # The agent's version display name. Only applicable to automated agents. + "versionId": "A String", # The agent's version ID. Only applicable to automated agents. }, "createTime": "A String", # Output only. The time at which the assessment was created. "name": "A String", # Identifier. The resource name of the assessment. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment} @@ -281,6 +297,8 @@

Method Details

"agentInfo": { # Information about an agent involved in the conversation. # Information about the agent the assessment is for. "agentId": "A String", # A user-specified string representing the agent. "agentType": "A String", # The agent type, e.g. HUMAN_AGENT. + "deploymentDisplayName": "A String", # The agent's deployment display name. Only applicable to automated agents. + "deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents. "displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. "location": "A String", # The agent's location. @@ -288,6 +306,8 @@

Method Details

"teams": [ # User-specified strings representing the agent's teams. "A String", ], + "versionDisplayName": "A String", # The agent's version display name. Only applicable to automated agents. + "versionId": "A String", # The agent's version ID. Only applicable to automated agents. }, "createTime": "A String", # Output only. The time at which the assessment was created. "name": "A String", # Identifier. The resource name of the assessment. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment} @@ -319,6 +339,8 @@

Method Details

"agentInfo": { # Information about an agent involved in the conversation. # Information about the agent the assessment is for. "agentId": "A String", # A user-specified string representing the agent. "agentType": "A String", # The agent type, e.g. HUMAN_AGENT. + "deploymentDisplayName": "A String", # The agent's deployment display name. Only applicable to automated agents. + "deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents. "displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. "location": "A String", # The agent's location. @@ -326,6 +348,8 @@

Method Details

"teams": [ # User-specified strings representing the agent's teams. "A String", ], + "versionDisplayName": "A String", # The agent's version display name. Only applicable to automated agents. + "versionId": "A String", # The agent's version ID. Only applicable to automated agents. }, "createTime": "A String", # Output only. The time at which the assessment was created. "name": "A String", # Identifier. The resource name of the assessment. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment} @@ -375,6 +399,8 @@

Method Details

"agentInfo": { # Information about an agent involved in the conversation. # Information about the agent the assessment is for. "agentId": "A String", # A user-specified string representing the agent. "agentType": "A String", # The agent type, e.g. HUMAN_AGENT. + "deploymentDisplayName": "A String", # The agent's deployment display name. Only applicable to automated agents. + "deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents. "displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. "location": "A String", # The agent's location. @@ -382,6 +408,8 @@

Method Details

"teams": [ # User-specified strings representing the agent's teams. "A String", ], + "versionDisplayName": "A String", # The agent's version display name. Only applicable to automated agents. + "versionId": "A String", # The agent's version ID. Only applicable to automated agents. }, "createTime": "A String", # Output only. The time at which the assessment was created. "name": "A String", # Identifier. The resource name of the assessment. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment} diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.html b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.html index ea385f50c2e..cebb1c7d495 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.html @@ -122,6 +122,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -150,6 +153,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -202,6 +208,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -241,6 +250,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -287,6 +299,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -315,6 +330,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. 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 f97b1266de8..5e7ab681c73 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.html @@ -406,6 +406,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -420,6 +423,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -531,6 +537,8 @@

Method Details

{ # Information about an agent involved in the conversation. "agentId": "A String", # A user-specified string representing the agent. "agentType": "A String", # The agent type, e.g. HUMAN_AGENT. + "deploymentDisplayName": "A String", # The agent's deployment display name. Only applicable to automated agents. + "deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents. "displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. "location": "A String", # The agent's location. @@ -538,6 +546,8 @@

Method Details

"teams": [ # User-specified strings representing the agent's teams. "A String", ], + "versionDisplayName": "A String", # The agent's version display name. Only applicable to automated agents. + "versionId": "A String", # The agent's version ID. Only applicable to automated agents. }, ], "customerSatisfactionRating": 42, # An arbitrary integer value indicating the customer's satisfaction rating. @@ -554,6 +564,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -838,6 +851,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -852,6 +868,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -963,6 +982,8 @@

Method Details

{ # Information about an agent involved in the conversation. "agentId": "A String", # A user-specified string representing the agent. "agentType": "A String", # The agent type, e.g. HUMAN_AGENT. + "deploymentDisplayName": "A String", # The agent's deployment display name. Only applicable to automated agents. + "deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents. "displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. "location": "A String", # The agent's location. @@ -970,6 +991,8 @@

Method Details

"teams": [ # User-specified strings representing the agent's teams. "A String", ], + "versionDisplayName": "A String", # The agent's version display name. Only applicable to automated agents. + "versionId": "A String", # The agent's version ID. Only applicable to automated agents. }, ], "customerSatisfactionRating": 42, # An arbitrary integer value indicating the customer's satisfaction rating. @@ -986,6 +1009,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.html b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.html index 79079e2a93f..a4a54799078 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.html @@ -350,9 +350,13 @@

Method Details

"dimensions": [ # The dimensions that determine the grouping key for the query. Defaults to no dimension if this field is unspecified. If a dimension is specified, its key must also be specified. Each dimension's key must be unique. If a time granularity is also specified, metric values in the dimension will be bucketed by this granularity. Up to one dimension is supported for now. { # A dimension determines the grouping key for the query. In SQL terms, these would be part of both the "SELECT" and "GROUP BY" clauses. "agentDimensionMetadata": { # Metadata about the agent dimension. # Output only. Metadata about the agent dimension. - "agentDisplayName": "A String", # Optional. The agent's name - "agentId": "A String", # Optional. A user-specified string representing the agent. + "agentDeploymentDisplayName": "A String", # Optional. The agent's deployment display name. Only applicable to automated agents. This will be populated for AGENT_DEPLOYMENT_ID dimensions. + "agentDeploymentId": "A String", # Optional. The agent's deployment ID. Only applicable to automated agents. This will be populated for AGENT and AGENT_DEPLOYMENT_ID dimensions. + "agentDisplayName": "A String", # Optional. The agent's name This will be populated for AGENT, AGENT_TEAM, AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions. + "agentId": "A String", # Optional. A user-specified string representing the agent. This will be populated for AGENT, AGENT_TEAM, AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions. "agentTeam": "A String", # Optional. A user-specified string representing the agent's team. + "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. }, "dimensionKey": "A String", # The key of the dimension. "issueDimensionMetadata": { # Metadata about the issue dimension. # Output only. Metadata about the issue dimension. @@ -371,6 +375,9 @@

Method Details

"qaScorecardId": "A String", # Optional. The QA scorecard ID. "questionBody": "A String", # Optional. The full body of the question. }, + "qaScorecardDimensionMetadata": { # Metadata about the QA scorecard dimension. # Output only. Metadata about the QA scorecard dimension. + "qaScorecardId": "A String", # Optional. The QA scorecard ID. + }, }, ], "filter": "A String", # Required. Filter to select a subset of conversations to compute the metrics. Must specify a window of the conversation create time to compute the metrics. The returned metrics will be from the range [DATE(starting create time), DATE(ending create time)). diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.operations.html b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.operations.html index 2232d5e8ef6..b36e6768f12 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.operations.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.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/contactcenterinsights_v1.projects.locations.conversations.analyses.html b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.analyses.html index cf87e90ce1a..eedfa481690 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.analyses.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.analyses.html @@ -210,6 +210,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -224,6 +227,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -478,6 +484,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -492,6 +501,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -705,6 +717,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -719,6 +734,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.assessments.html b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.assessments.html index 67aa4c60e5f..e01b19affe7 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.assessments.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.assessments.html @@ -131,6 +131,8 @@

Method Details

"agentInfo": { # Information about an agent involved in the conversation. # Information about the agent the assessment is for. "agentId": "A String", # A user-specified string representing the agent. "agentType": "A String", # The agent type, e.g. HUMAN_AGENT. + "deploymentDisplayName": "A String", # The agent's deployment display name. Only applicable to automated agents. + "deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents. "displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. "location": "A String", # The agent's location. @@ -138,6 +140,8 @@

Method Details

"teams": [ # User-specified strings representing the agent's teams. "A String", ], + "versionDisplayName": "A String", # The agent's version display name. Only applicable to automated agents. + "versionId": "A String", # The agent's version ID. Only applicable to automated agents. }, "createTime": "A String", # Output only. The time at which the assessment was created. "name": "A String", # Identifier. The resource name of the assessment. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment} @@ -164,6 +168,8 @@

Method Details

"agentInfo": { # Information about an agent involved in the conversation. # Information about the agent the assessment is for. "agentId": "A String", # A user-specified string representing the agent. "agentType": "A String", # The agent type, e.g. HUMAN_AGENT. + "deploymentDisplayName": "A String", # The agent's deployment display name. Only applicable to automated agents. + "deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents. "displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. "location": "A String", # The agent's location. @@ -171,6 +177,8 @@

Method Details

"teams": [ # User-specified strings representing the agent's teams. "A String", ], + "versionDisplayName": "A String", # The agent's version display name. Only applicable to automated agents. + "versionId": "A String", # The agent's version ID. Only applicable to automated agents. }, "createTime": "A String", # Output only. The time at which the assessment was created. "name": "A String", # Identifier. The resource name of the assessment. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment} @@ -190,6 +198,8 @@

Method Details

"agentInfo": { # Information about an agent involved in the conversation. # Information about the agent the assessment is for. "agentId": "A String", # A user-specified string representing the agent. "agentType": "A String", # The agent type, e.g. HUMAN_AGENT. + "deploymentDisplayName": "A String", # The agent's deployment display name. Only applicable to automated agents. + "deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents. "displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. "location": "A String", # The agent's location. @@ -197,6 +207,8 @@

Method Details

"teams": [ # User-specified strings representing the agent's teams. "A String", ], + "versionDisplayName": "A String", # The agent's version display name. Only applicable to automated agents. + "versionId": "A String", # The agent's version ID. Only applicable to automated agents. }, "createTime": "A String", # Output only. The time at which the assessment was created. "name": "A String", # Identifier. The resource name of the assessment. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment} @@ -248,6 +260,8 @@

Method Details

"agentInfo": { # Information about an agent involved in the conversation. # Information about the agent the assessment is for. "agentId": "A String", # A user-specified string representing the agent. "agentType": "A String", # The agent type, e.g. HUMAN_AGENT. + "deploymentDisplayName": "A String", # The agent's deployment display name. Only applicable to automated agents. + "deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents. "displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. "location": "A String", # The agent's location. @@ -255,6 +269,8 @@

Method Details

"teams": [ # User-specified strings representing the agent's teams. "A String", ], + "versionDisplayName": "A String", # The agent's version display name. Only applicable to automated agents. + "versionId": "A String", # The agent's version ID. Only applicable to automated agents. }, "createTime": "A String", # Output only. The time at which the assessment was created. "name": "A String", # Identifier. The resource name of the assessment. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment} @@ -281,6 +297,8 @@

Method Details

"agentInfo": { # Information about an agent involved in the conversation. # Information about the agent the assessment is for. "agentId": "A String", # A user-specified string representing the agent. "agentType": "A String", # The agent type, e.g. HUMAN_AGENT. + "deploymentDisplayName": "A String", # The agent's deployment display name. Only applicable to automated agents. + "deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents. "displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. "location": "A String", # The agent's location. @@ -288,6 +306,8 @@

Method Details

"teams": [ # User-specified strings representing the agent's teams. "A String", ], + "versionDisplayName": "A String", # The agent's version display name. Only applicable to automated agents. + "versionId": "A String", # The agent's version ID. Only applicable to automated agents. }, "createTime": "A String", # Output only. The time at which the assessment was created. "name": "A String", # Identifier. The resource name of the assessment. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment} @@ -319,6 +339,8 @@

Method Details

"agentInfo": { # Information about an agent involved in the conversation. # Information about the agent the assessment is for. "agentId": "A String", # A user-specified string representing the agent. "agentType": "A String", # The agent type, e.g. HUMAN_AGENT. + "deploymentDisplayName": "A String", # The agent's deployment display name. Only applicable to automated agents. + "deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents. "displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. "location": "A String", # The agent's location. @@ -326,6 +348,8 @@

Method Details

"teams": [ # User-specified strings representing the agent's teams. "A String", ], + "versionDisplayName": "A String", # The agent's version display name. Only applicable to automated agents. + "versionId": "A String", # The agent's version ID. Only applicable to automated agents. }, "createTime": "A String", # Output only. The time at which the assessment was created. "name": "A String", # Identifier. The resource name of the assessment. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment} @@ -375,6 +399,8 @@

Method Details

"agentInfo": { # Information about an agent involved in the conversation. # Information about the agent the assessment is for. "agentId": "A String", # A user-specified string representing the agent. "agentType": "A String", # The agent type, e.g. HUMAN_AGENT. + "deploymentDisplayName": "A String", # The agent's deployment display name. Only applicable to automated agents. + "deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents. "displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. "location": "A String", # The agent's location. @@ -382,6 +408,8 @@

Method Details

"teams": [ # User-specified strings representing the agent's teams. "A String", ], + "versionDisplayName": "A String", # The agent's version display name. Only applicable to automated agents. + "versionId": "A String", # The agent's version ID. Only applicable to automated agents. }, "createTime": "A String", # Output only. The time at which the assessment was created. "name": "A String", # Identifier. The resource name of the assessment. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment} diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.feedbackLabels.html b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.feedbackLabels.html index 048a881bfc8..24f8e615475 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.feedbackLabels.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.feedbackLabels.html @@ -122,6 +122,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -150,6 +153,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -202,6 +208,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -241,6 +250,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -287,6 +299,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -315,6 +330,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.html b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.html index de2353b2823..4a318a740bd 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.html @@ -440,6 +440,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -454,6 +457,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -565,6 +571,8 @@

Method Details

{ # Information about an agent involved in the conversation. "agentId": "A String", # A user-specified string representing the agent. "agentType": "A String", # The agent type, e.g. HUMAN_AGENT. + "deploymentDisplayName": "A String", # The agent's deployment display name. Only applicable to automated agents. + "deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents. "displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. "location": "A String", # The agent's location. @@ -572,6 +580,8 @@

Method Details

"teams": [ # User-specified strings representing the agent's teams. "A String", ], + "versionDisplayName": "A String", # The agent's version display name. Only applicable to automated agents. + "versionId": "A String", # The agent's version ID. Only applicable to automated agents. }, ], "customerSatisfactionRating": 42, # An arbitrary integer value indicating the customer's satisfaction rating. @@ -588,6 +598,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -855,6 +868,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -869,6 +885,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -980,6 +999,8 @@

Method Details

{ # Information about an agent involved in the conversation. "agentId": "A String", # A user-specified string representing the agent. "agentType": "A String", # The agent type, e.g. HUMAN_AGENT. + "deploymentDisplayName": "A String", # The agent's deployment display name. Only applicable to automated agents. + "deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents. "displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. "location": "A String", # The agent's location. @@ -987,6 +1008,8 @@

Method Details

"teams": [ # User-specified strings representing the agent's teams. "A String", ], + "versionDisplayName": "A String", # The agent's version display name. Only applicable to automated agents. + "versionId": "A String", # The agent's version ID. Only applicable to automated agents. }, ], "customerSatisfactionRating": 42, # An arbitrary integer value indicating the customer's satisfaction rating. @@ -1003,6 +1026,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -1300,6 +1326,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -1314,6 +1343,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -1425,6 +1457,8 @@

Method Details

{ # Information about an agent involved in the conversation. "agentId": "A String", # A user-specified string representing the agent. "agentType": "A String", # The agent type, e.g. HUMAN_AGENT. + "deploymentDisplayName": "A String", # The agent's deployment display name. Only applicable to automated agents. + "deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents. "displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. "location": "A String", # The agent's location. @@ -1432,6 +1466,8 @@

Method Details

"teams": [ # User-specified strings representing the agent's teams. "A String", ], + "versionDisplayName": "A String", # The agent's version display name. Only applicable to automated agents. + "versionId": "A String", # The agent's version ID. Only applicable to automated agents. }, ], "customerSatisfactionRating": 42, # An arbitrary integer value indicating the customer's satisfaction rating. @@ -1448,6 +1484,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -1800,6 +1839,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -1814,6 +1856,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -1925,6 +1970,8 @@

Method Details

{ # Information about an agent involved in the conversation. "agentId": "A String", # A user-specified string representing the agent. "agentType": "A String", # The agent type, e.g. HUMAN_AGENT. + "deploymentDisplayName": "A String", # The agent's deployment display name. Only applicable to automated agents. + "deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents. "displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. "location": "A String", # The agent's location. @@ -1932,6 +1979,8 @@

Method Details

"teams": [ # User-specified strings representing the agent's teams. "A String", ], + "versionDisplayName": "A String", # The agent's version display name. Only applicable to automated agents. + "versionId": "A String", # The agent's version ID. Only applicable to automated agents. }, ], "customerSatisfactionRating": 42, # An arbitrary integer value indicating the customer's satisfaction rating. @@ -1948,6 +1997,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -2233,6 +2285,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -2247,6 +2302,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -2358,6 +2416,8 @@

Method Details

{ # Information about an agent involved in the conversation. "agentId": "A String", # A user-specified string representing the agent. "agentType": "A String", # The agent type, e.g. HUMAN_AGENT. + "deploymentDisplayName": "A String", # The agent's deployment display name. Only applicable to automated agents. + "deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents. "displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. "location": "A String", # The agent's location. @@ -2365,6 +2425,8 @@

Method Details

"teams": [ # User-specified strings representing the agent's teams. "A String", ], + "versionDisplayName": "A String", # The agent's version display name. Only applicable to automated agents. + "versionId": "A String", # The agent's version ID. Only applicable to automated agents. }, ], "customerSatisfactionRating": 42, # An arbitrary integer value indicating the customer's satisfaction rating. @@ -2381,6 +2443,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -2649,6 +2714,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -2663,6 +2731,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -2774,6 +2845,8 @@

Method Details

{ # Information about an agent involved in the conversation. "agentId": "A String", # A user-specified string representing the agent. "agentType": "A String", # The agent type, e.g. HUMAN_AGENT. + "deploymentDisplayName": "A String", # The agent's deployment display name. Only applicable to automated agents. + "deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents. "displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. "location": "A String", # The agent's location. @@ -2781,6 +2854,8 @@

Method Details

"teams": [ # User-specified strings representing the agent's teams. "A String", ], + "versionDisplayName": "A String", # The agent's version display name. Only applicable to automated agents. + "versionId": "A String", # The agent's version ID. Only applicable to automated agents. }, ], "customerSatisfactionRating": 42, # An arbitrary integer value indicating the customer's satisfaction rating. @@ -2797,6 +2872,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -3123,6 +3201,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -3137,6 +3218,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -3248,6 +3332,8 @@

Method Details

{ # Information about an agent involved in the conversation. "agentId": "A String", # A user-specified string representing the agent. "agentType": "A String", # The agent type, e.g. HUMAN_AGENT. + "deploymentDisplayName": "A String", # The agent's deployment display name. Only applicable to automated agents. + "deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents. "displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. "location": "A String", # The agent's location. @@ -3255,6 +3341,8 @@

Method Details

"teams": [ # User-specified strings representing the agent's teams. "A String", ], + "versionDisplayName": "A String", # The agent's version display name. Only applicable to automated agents. + "versionId": "A String", # The agent's version ID. Only applicable to automated agents. }, ], "customerSatisfactionRating": 42, # An arbitrary integer value indicating the customer's satisfaction rating. @@ -3271,6 +3359,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.conversations.analyses.html b/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.conversations.analyses.html index 0f00e81eaca..151c9b74f7a 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.conversations.analyses.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.conversations.analyses.html @@ -210,6 +210,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -224,6 +227,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -478,6 +484,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -492,6 +501,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -705,6 +717,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -719,6 +734,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.conversations.feedbackLabels.html b/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.conversations.feedbackLabels.html index d504515f4f2..8054c994628 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.conversations.feedbackLabels.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.conversations.feedbackLabels.html @@ -122,6 +122,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -150,6 +153,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -202,6 +208,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -241,6 +250,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -287,6 +299,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -315,6 +330,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.conversations.html b/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.conversations.html index b4f0afd1dd3..799a59b0d62 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.conversations.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.conversations.html @@ -461,6 +461,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -475,6 +478,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -586,6 +592,8 @@

Method Details

{ # Information about an agent involved in the conversation. "agentId": "A String", # A user-specified string representing the agent. "agentType": "A String", # The agent type, e.g. HUMAN_AGENT. + "deploymentDisplayName": "A String", # The agent's deployment display name. Only applicable to automated agents. + "deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents. "displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. "location": "A String", # The agent's location. @@ -593,6 +601,8 @@

Method Details

"teams": [ # User-specified strings representing the agent's teams. "A String", ], + "versionDisplayName": "A String", # The agent's version display name. Only applicable to automated agents. + "versionId": "A String", # The agent's version ID. Only applicable to automated agents. }, ], "customerSatisfactionRating": 42, # An arbitrary integer value indicating the customer's satisfaction rating. @@ -609,6 +619,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -961,6 +974,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -975,6 +991,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -1086,6 +1105,8 @@

Method Details

{ # Information about an agent involved in the conversation. "agentId": "A String", # A user-specified string representing the agent. "agentType": "A String", # The agent type, e.g. HUMAN_AGENT. + "deploymentDisplayName": "A String", # The agent's deployment display name. Only applicable to automated agents. + "deploymentId": "A String", # The agent's deployment ID. Only applicable to automated agents. "displayName": "A String", # The agent's name. "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call. "location": "A String", # The agent's location. @@ -1093,6 +1114,8 @@

Method Details

"teams": [ # User-specified strings representing the agent's teams. "A String", ], + "versionDisplayName": "A String", # The agent's version display name. Only applicable to automated agents. + "versionId": "A String", # The agent's version ID. Only applicable to automated agents. }, ], "customerSatisfactionRating": 42, # An arbitrary integer value indicating the customer's satisfaction rating. @@ -1109,6 +1132,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.html b/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.html index 9024de32927..1908742e77d 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.html @@ -441,6 +441,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.html b/docs/dyn/contactcenterinsights_v1.projects.locations.html index d54f686d9b0..e79e8cf62f3 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.html @@ -447,6 +447,9 @@

Method Details

"normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score. "numValue": 3.14, # Numerical value. "potentialScore": 3.14, # Output only. The maximum potential score of the question. + "rationale": { # Wrapper for the rationale for the answer. # Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales. + "rationale": "A String", # The rationale string for the answer. + }, "score": 3.14, # Output only. Numerical score of the answer. "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. @@ -485,9 +488,13 @@

Method Details

"dimensions": [ # The dimensions that determine the grouping key for the query. Defaults to no dimension if this field is unspecified. If a dimension is specified, its key must also be specified. Each dimension's key must be unique. If a time granularity is also specified, metric values in the dimension will be bucketed by this granularity. Up to one dimension is supported for now. { # A dimension determines the grouping key for the query. In SQL terms, these would be part of both the "SELECT" and "GROUP BY" clauses. "agentDimensionMetadata": { # Metadata about the agent dimension. # Output only. Metadata about the agent dimension. - "agentDisplayName": "A String", # Optional. The agent's name - "agentId": "A String", # Optional. A user-specified string representing the agent. + "agentDeploymentDisplayName": "A String", # Optional. The agent's deployment display name. Only applicable to automated agents. This will be populated for AGENT_DEPLOYMENT_ID dimensions. + "agentDeploymentId": "A String", # Optional. The agent's deployment ID. Only applicable to automated agents. This will be populated for AGENT and AGENT_DEPLOYMENT_ID dimensions. + "agentDisplayName": "A String", # Optional. The agent's name This will be populated for AGENT, AGENT_TEAM, AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions. + "agentId": "A String", # Optional. A user-specified string representing the agent. This will be populated for AGENT, AGENT_TEAM, AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions. "agentTeam": "A String", # Optional. A user-specified string representing the agent's team. + "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. }, "dimensionKey": "A String", # The key of the dimension. "issueDimensionMetadata": { # Metadata about the issue dimension. # Output only. Metadata about the issue dimension. @@ -506,6 +513,9 @@

Method Details

"qaScorecardId": "A String", # Optional. The QA scorecard ID. "questionBody": "A String", # Optional. The full body of the question. }, + "qaScorecardDimensionMetadata": { # Metadata about the QA scorecard dimension. # Output only. Metadata about the QA scorecard dimension. + "qaScorecardId": "A String", # Optional. The QA scorecard ID. + }, }, ], "filter": "A String", # Required. Filter to select a subset of conversations to compute the metrics. Must specify a window of the conversation create time to compute the metrics. The returned metrics will be from the range [DATE(starting create time), DATE(ending create time)). diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.operations.html b/docs/dyn/contactcenterinsights_v1.projects.locations.operations.html index 27680e9942d..f6b64ef15f1 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.operations.html +++ b/docs/dyn/contactcenterinsights_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/contactcenterinsights.v1.json b/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json index 015687691c8..05ea033a6ad 100644 --- a/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json +++ b/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json @@ -2117,6 +2117,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", @@ -4589,6 +4594,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", @@ -5638,7 +5648,7 @@ } } }, -"revision": "20250915", +"revision": "20250926", "rootUrl": "https://contactcenterinsights.googleapis.com/", "schemas": { "GoogleCloudContactcenterinsightsV1Analysis": { @@ -7034,6 +7044,14 @@ true ], "type": "string" }, +"deploymentDisplayName": { +"description": "The agent's deployment display name. Only applicable to automated agents.", +"type": "string" +}, +"deploymentId": { +"description": "The agent's deployment ID. Only applicable to automated agents.", +"type": "string" +}, "displayName": { "description": "The agent's name.", "type": "string" @@ -7057,6 +7075,14 @@ true "type": "string" }, "type": "array" +}, +"versionDisplayName": { +"description": "The agent's version display name. Only applicable to automated agents.", +"type": "string" +}, +"versionId": { +"description": "The agent's version ID. Only applicable to automated agents.", +"type": "string" } }, "type": "object" @@ -7537,7 +7563,9 @@ true "QA_QUESTION_ANSWER_VALUE", "QA_SCORECARD_ID", "CONVERSATION_PROFILE_ID", -"MEDIUM" +"MEDIUM", +"AGENT_VERSION_ID", +"AGENT_DEPLOYMENT_ID" ], "enumDescriptions": [ "The key of the dimension is unspecified.", @@ -7549,7 +7577,9 @@ true "The dimension is keyed by QaQuestionIds-Answer value pairs. Note that: We only group by the QuestionId and not the revision-id of the scorecard this question is a part of. This allows for showing distribution of answers per question across different scorecard revisions.", "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 conversation medium.", +"The dimension is keyed by the agent version ID.", +"The dimension is keyed by the agent deployment ID." ], "type": "string" }, @@ -7567,6 +7597,11 @@ true "$ref": "GoogleCloudContactcenterinsightsV1DimensionQaQuestionDimensionMetadata", "description": "Output only. Metadata about the QA question dimension.", "readOnly": true +}, +"qaScorecardDimensionMetadata": { +"$ref": "GoogleCloudContactcenterinsightsV1DimensionQaScorecardDimensionMetadata", +"description": "Output only. Metadata about the QA scorecard dimension.", +"readOnly": true } }, "type": "object" @@ -7575,17 +7610,33 @@ true "description": "Metadata about the agent dimension.", "id": "GoogleCloudContactcenterinsightsV1DimensionAgentDimensionMetadata", "properties": { +"agentDeploymentDisplayName": { +"description": "Optional. The agent's deployment display name. Only applicable to automated agents. This will be populated for AGENT_DEPLOYMENT_ID dimensions.", +"type": "string" +}, +"agentDeploymentId": { +"description": "Optional. The agent's deployment ID. Only applicable to automated agents. This will be populated for AGENT and AGENT_DEPLOYMENT_ID dimensions.", +"type": "string" +}, "agentDisplayName": { -"description": "Optional. The agent's name", +"description": "Optional. The agent's name This will be populated for AGENT, AGENT_TEAM, AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions.", "type": "string" }, "agentId": { -"description": "Optional. A user-specified string representing the agent.", +"description": "Optional. A user-specified string representing the agent. This will be populated for AGENT, AGENT_TEAM, AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions.", "type": "string" }, "agentTeam": { "description": "Optional. A user-specified string representing the agent's team.", "type": "string" +}, +"agentVersionDisplayName": { +"description": "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.", +"type": "string" +}, +"agentVersionId": { +"description": "Optional. The agent's version ID. Only applicable to automated agents. This will be populated for AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions.", +"type": "string" } }, "type": "object" @@ -7651,6 +7702,17 @@ true }, "type": "object" }, +"GoogleCloudContactcenterinsightsV1DimensionQaScorecardDimensionMetadata": { +"description": "Metadata about the QA scorecard dimension.", +"id": "GoogleCloudContactcenterinsightsV1DimensionQaScorecardDimensionMetadata", +"properties": { +"qaScorecardId": { +"description": "Optional. The QA scorecard ID.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudContactcenterinsightsV1EncryptionSpec": { "description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. `Conversation`).", "id": "GoogleCloudContactcenterinsightsV1EncryptionSpec", @@ -9310,6 +9372,11 @@ true "readOnly": true, "type": "number" }, +"rationale": { +"$ref": "GoogleCloudContactcenterinsightsV1QaAnswerAnswerValueQaAnswerRationale", +"description": "Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales.", +"readOnly": true +}, "score": { "description": "Output only. Numerical score of the answer.", "format": "double", @@ -9328,6 +9395,17 @@ true }, "type": "object" }, +"GoogleCloudContactcenterinsightsV1QaAnswerAnswerValueQaAnswerRationale": { +"description": "Wrapper for the rationale for the answer.", +"id": "GoogleCloudContactcenterinsightsV1QaAnswerAnswerValueQaAnswerRationale", +"properties": { +"rationale": { +"description": "The rationale string for the answer.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudContactcenterinsightsV1QaQuestion": { "description": "A single question to be scored by the Insights QA feature.", "id": "GoogleCloudContactcenterinsightsV1QaQuestion", @@ -9869,7 +9947,7 @@ true }, "macroAverageSlice": { "$ref": "GoogleCloudContactcenterinsightsV1QueryMetricsResponseSlice", -"description": "The macro average slice contains aggregated averages across the selected dimension. i.e. if group_by agent is specified this field will contain the average across all agents. This field is only populated if the request specifies a Dimension." +"description": "The macro average slice contains aggregated averages across all selected dimensions. i.e. if group_by agent and scorecard_id is specified, this field will contain the average across all agents and all scorecards. This field is only populated if the request specifies a Dimension." }, "slices": { "description": "A slice contains a total and (if the request specified a time granularity) a time series of metric values. Each slice contains a unique combination of the cardinality of dimensions from the request.", @@ -9948,7 +10026,7 @@ true "type": "string" }, "averageQaNormalizedScore": { -"description": "Average QA normalized score. Will exclude 0's in average calculation.", +"description": "The average normalized QA score for a scorecard. When computing the average across a set of conversations, if a conversation has been evaluated with multiple revisions of a scorecard, only the latest revision results will be used. Will exclude 0's in average calculation. Will be only populated if the request specifies a dimension of QA_SCORECARD_ID.", "format": "double", "type": "number" }, @@ -11525,6 +11603,14 @@ true ], "type": "string" }, +"deploymentDisplayName": { +"description": "The agent's deployment display name. Only applicable to automated agents.", +"type": "string" +}, +"deploymentId": { +"description": "The agent's deployment ID. Only applicable to automated agents.", +"type": "string" +}, "displayName": { "description": "The agent's name.", "type": "string" @@ -11548,6 +11634,14 @@ true "type": "string" }, "type": "array" +}, +"versionDisplayName": { +"description": "The agent's version display name. Only applicable to automated agents.", +"type": "string" +}, +"versionId": { +"description": "The agent's version ID. Only applicable to automated agents.", +"type": "string" } }, "type": "object" @@ -12022,7 +12116,9 @@ true "QA_QUESTION_ANSWER_VALUE", "QA_SCORECARD_ID", "CONVERSATION_PROFILE_ID", -"MEDIUM" +"MEDIUM", +"AGENT_VERSION_ID", +"AGENT_DEPLOYMENT_ID" ], "enumDescriptions": [ "The key of the dimension is unspecified.", @@ -12034,7 +12130,9 @@ true "The dimension is keyed by QaQuestionIds-Answer value pairs. Note that: We only group by the QuestionId and not the revision-id of the scorecard this question is a part of. This allows for showing distribution of answers per question across different scorecard revisions.", "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 conversation medium.", +"The dimension is keyed by the agent version ID.", +"The dimension is keyed by the agent deployment ID." ], "type": "string" }, @@ -12052,6 +12150,11 @@ true "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionDimensionMetadata", "description": "Output only. Metadata about the QA question dimension.", "readOnly": true +}, +"qaScorecardDimensionMetadata": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionQaScorecardDimensionMetadata", +"description": "Output only. Metadata about the QA scorecard dimension.", +"readOnly": true } }, "type": "object" @@ -12060,17 +12163,33 @@ true "description": "Metadata about the agent dimension.", "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionAgentDimensionMetadata", "properties": { +"agentDeploymentDisplayName": { +"description": "Optional. The agent's deployment display name. Only applicable to automated agents. This will be populated for AGENT_DEPLOYMENT_ID dimensions.", +"type": "string" +}, +"agentDeploymentId": { +"description": "Optional. The agent's deployment ID. Only applicable to automated agents. This will be populated for AGENT and AGENT_DEPLOYMENT_ID dimensions.", +"type": "string" +}, "agentDisplayName": { -"description": "Optional. The agent's name", +"description": "Optional. The agent's name This will be populated for AGENT, AGENT_TEAM, AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions.", "type": "string" }, "agentId": { -"description": "Optional. A user-specified string representing the agent.", +"description": "Optional. A user-specified string representing the agent. This will be populated for AGENT, AGENT_TEAM, AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions.", "type": "string" }, "agentTeam": { "description": "Optional. A user-specified string representing the agent's team.", "type": "string" +}, +"agentVersionDisplayName": { +"description": "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.", +"type": "string" +}, +"agentVersionId": { +"description": "Optional. The agent's version ID. Only applicable to automated agents. This will be populated for AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions.", +"type": "string" } }, "type": "object" @@ -12136,6 +12255,17 @@ true }, "type": "object" }, +"GoogleCloudContactcenterinsightsV1alpha1DimensionQaScorecardDimensionMetadata": { +"description": "Metadata about the QA scorecard dimension.", +"id": "GoogleCloudContactcenterinsightsV1alpha1DimensionQaScorecardDimensionMetadata", +"properties": { +"qaScorecardId": { +"description": "Optional. The QA scorecard ID.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec": { "description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. `Conversation`).", "id": "GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec", @@ -13258,6 +13388,11 @@ true "readOnly": true, "type": "number" }, +"rationale": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValueQaAnswerRationale", +"description": "Output only. The rationale for the answer. This field is only populated for answers that are generated by the LLM. Manual edits currently do not have rationales.", +"readOnly": true +}, "score": { "description": "Output only. Numerical score of the answer.", "format": "double", @@ -13276,6 +13411,17 @@ true }, "type": "object" }, +"GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValueQaAnswerRationale": { +"description": "Wrapper for the rationale for the answer.", +"id": "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValueQaAnswerRationale", +"properties": { +"rationale": { +"description": "The rationale string for the answer.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag": { "description": "A tag is a resource which aims to categorize a set of questions across multiple scorecards, e.g., \"Customer Satisfaction\",\"Billing\", etc.", "id": "GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag", @@ -13465,7 +13611,7 @@ true }, "macroAverageSlice": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1QueryMetricsResponseSlice", -"description": "The macro average slice contains aggregated averages across the selected dimension. i.e. if group_by agent is specified this field will contain the average across all agents. This field is only populated if the request specifies a Dimension." +"description": "The macro average slice contains aggregated averages across all selected dimensions. i.e. if group_by agent and scorecard_id is specified, this field will contain the average across all agents and all scorecards. This field is only populated if the request specifies a Dimension." }, "slices": { "description": "A slice contains a total and (if the request specified a time granularity) a time series of metric values. Each slice contains a unique combination of the cardinality of dimensions from the request.", @@ -13544,7 +13690,7 @@ true "type": "string" }, "averageQaNormalizedScore": { -"description": "Average QA normalized score. Will exclude 0's in average calculation.", +"description": "The average normalized QA score for a scorecard. When computing the average across a set of conversations, if a conversation has been evaluated with multiple revisions of a scorecard, only the latest revision results will be used. Will exclude 0's in average calculation. Will be only populated if the request specifies a dimension of QA_SCORECARD_ID.", "format": "double", "type": "number" }, @@ -14219,6 +14365,13 @@ true "$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 67ec89a5ce13e636cdece6268224ecff16081377 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 30 Sep 2025 07:09:35 +0000 Subject: [PATCH 13/42] feat(container): update the api #### container:v1beta1 The following keys were added: - schemas.Cluster.properties.enterpriseConfig.deprecated (Total Keys: 1) - schemas.ClusterUpdate.properties.desiredEnterpriseConfig.deprecated (Total Keys: 1) - schemas.DNSEndpointConfig.properties.enableK8sCertsViaDns.type (Total Keys: 1) - schemas.DNSEndpointConfig.properties.enableK8sTokensViaDns.type (Total Keys: 1) - schemas.DesiredEnterpriseConfig.deprecated (Total Keys: 1) - schemas.EnterpriseConfig.deprecated (Total Keys: 1) --- ...r_v1beta1.projects.locations.clusters.html | 82 ++++++++++--------- ...projects.locations.clusters.nodePools.html | 10 +-- ...ainer_v1beta1.projects.zones.clusters.html | 82 ++++++++++--------- ...ta1.projects.zones.clusters.nodePools.html | 10 +-- .../documents/container.v1beta1.json | 42 ++++++---- 5 files changed, 127 insertions(+), 99 deletions(-) diff --git a/docs/dyn/container_v1beta1.projects.locations.clusters.html b/docs/dyn/container_v1beta1.projects.locations.clusters.html index b2bbf73eec2..17692da0f5e 100644 --- a/docs/dyn/container_v1beta1.projects.locations.clusters.html +++ b/docs/dyn/container_v1beta1.projects.locations.clusters.html @@ -277,7 +277,7 @@

Method Details

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. "loadBalancerType": "A String", # Which load balancer type is installed for Cloud Run. }, - "configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted GCP services through the Kubernetes API + "configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted Google Cloud services through the Kubernetes API. "enabled": True or False, # Whether Cloud Connector is enabled for this cluster. }, "dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes @@ -286,8 +286,8 @@

Method Details

"gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. # Configuration for the Compute Engine Persistent Disk CSI driver. "enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster. }, - "gcpFilestoreCsiDriverConfig": { # Configuration for the GCP Filestore CSI driver. # Configuration for the GCP Filestore CSI driver. - "enabled": True or False, # Whether the GCP Filestore CSI driver is enabled for this cluster. + "gcpFilestoreCsiDriverConfig": { # Configuration for the Filestore CSI driver. # Configuration for the Filestore CSI driver. + "enabled": True or False, # Whether the Filestore CSI driver is enabled for this cluster. }, "gcsFuseCsiDriverConfig": { # Configuration for the Cloud Storage Fuse CSI driver. # Configuration for the Cloud Storage Fuse CSI driver. "enabled": True or False, # Whether the Cloud Storage Fuse CSI driver is enabled for this cluster. @@ -452,7 +452,9 @@

Method Details

}, "controlPlaneEndpointsConfig": { # Configuration for all of the cluster's control plane endpoints. # Configuration for all cluster's control plane endpoints. "dnsEndpointConfig": { # Describes the configuration of a DNS endpoint. # DNS endpoint configuration. - "allowExternalTraffic": True or False, # Controls whether user traffic is allowed over this endpoint. Note that GCP-managed services may still use the endpoint even if this is false. + "allowExternalTraffic": True or False, # Controls whether user traffic is allowed over this endpoint. Note that Google-managed services may still use the endpoint even if this is false. + "enableK8sCertsViaDns": True or False, # Controls whether the k8s certs auth is allowed via DNS. + "enableK8sTokensViaDns": True or False, # Controls whether the k8s token auth is allowed via DNS. "endpoint": "A String", # Output only. The cluster's DNS endpoint configuration. A DNS format address. This is accessible from the public internet. Ex: uid.us-central1.gke.goog. Always present, but the behavior may change according to the value of DNSEndpointConfig.allow_external_traffic. }, "ipEndpointsConfig": { # IP endpoints configuration. # IP endpoints configuration. @@ -509,7 +511,7 @@

Method Details

"enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1beta1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation. "enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. This field is deprecated, use tpu_config.enabled instead. This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25. "endpoint": "A String", # Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. - "enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. # GKE Enterprise Configuration. + "enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. Deprecated: GKE Enterprise features are now available without an Enterprise tier. # GKE Enterprise Configuration. Deprecated: GKE Enterprise features are now available without an Enterprise tier. "clusterTier": "A String", # Output only. cluster_tier indicates the effective tier of the cluster. "desiredTier": "A String", # desired_tier specifies the desired tier of the cluster. }, @@ -749,7 +751,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 [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/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" }, }, @@ -1023,7 +1025,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 [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/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" }, }, @@ -1163,7 +1165,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 [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/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" }, }, @@ -1561,7 +1563,7 @@

Method Details

"workloadCertificates": { # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. "enableCertificates": True or False, # enable_certificates controls issuance of workload mTLS certificates. If set, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster, which can then be configured by creating a WorkloadCertificateConfig Custom Resource. Requires Workload Identity (workload_pool must be non-empty). }, - "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. + "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in IAM policies. # Configuration for the use of Kubernetes Service Accounts in IAM policies. "identityNamespace": "A String", # IAM Identity Namespace to attach all Kubernetes Service Accounts to. "identityProvider": "A String", # identity provider is the third party identity provider. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. @@ -1766,7 +1768,7 @@

Method Details

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. "loadBalancerType": "A String", # Which load balancer type is installed for Cloud Run. }, - "configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted GCP services through the Kubernetes API + "configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted Google Cloud services through the Kubernetes API. "enabled": True or False, # Whether Cloud Connector is enabled for this cluster. }, "dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes @@ -1775,8 +1777,8 @@

Method Details

"gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. # Configuration for the Compute Engine Persistent Disk CSI driver. "enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster. }, - "gcpFilestoreCsiDriverConfig": { # Configuration for the GCP Filestore CSI driver. # Configuration for the GCP Filestore CSI driver. - "enabled": True or False, # Whether the GCP Filestore CSI driver is enabled for this cluster. + "gcpFilestoreCsiDriverConfig": { # Configuration for the Filestore CSI driver. # Configuration for the Filestore CSI driver. + "enabled": True or False, # Whether the Filestore CSI driver is enabled for this cluster. }, "gcsFuseCsiDriverConfig": { # Configuration for the Cloud Storage Fuse CSI driver. # Configuration for the Cloud Storage Fuse CSI driver. "enabled": True or False, # Whether the Cloud Storage Fuse CSI driver is enabled for this cluster. @@ -1941,7 +1943,9 @@

Method Details

}, "controlPlaneEndpointsConfig": { # Configuration for all of the cluster's control plane endpoints. # Configuration for all cluster's control plane endpoints. "dnsEndpointConfig": { # Describes the configuration of a DNS endpoint. # DNS endpoint configuration. - "allowExternalTraffic": True or False, # Controls whether user traffic is allowed over this endpoint. Note that GCP-managed services may still use the endpoint even if this is false. + "allowExternalTraffic": True or False, # Controls whether user traffic is allowed over this endpoint. Note that Google-managed services may still use the endpoint even if this is false. + "enableK8sCertsViaDns": True or False, # Controls whether the k8s certs auth is allowed via DNS. + "enableK8sTokensViaDns": True or False, # Controls whether the k8s token auth is allowed via DNS. "endpoint": "A String", # Output only. The cluster's DNS endpoint configuration. A DNS format address. This is accessible from the public internet. Ex: uid.us-central1.gke.goog. Always present, but the behavior may change according to the value of DNSEndpointConfig.allow_external_traffic. }, "ipEndpointsConfig": { # IP endpoints configuration. # IP endpoints configuration. @@ -1998,7 +2002,7 @@

Method Details

"enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1beta1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation. "enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. This field is deprecated, use tpu_config.enabled instead. This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25. "endpoint": "A String", # Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. - "enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. # GKE Enterprise Configuration. + "enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. Deprecated: GKE Enterprise features are now available without an Enterprise tier. # GKE Enterprise Configuration. Deprecated: GKE Enterprise features are now available without an Enterprise tier. "clusterTier": "A String", # Output only. cluster_tier indicates the effective tier of the cluster. "desiredTier": "A String", # desired_tier specifies the desired tier of the cluster. }, @@ -2238,7 +2242,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 [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/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" }, }, @@ -2512,7 +2516,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 [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/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" }, }, @@ -2652,7 +2656,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 [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/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" }, }, @@ -3050,7 +3054,7 @@

Method Details

"workloadCertificates": { # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. "enableCertificates": True or False, # enable_certificates controls issuance of workload mTLS certificates. If set, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster, which can then be configured by creating a WorkloadCertificateConfig Custom Resource. Requires Workload Identity (workload_pool must be non-empty). }, - "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. + "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in IAM policies. # Configuration for the use of Kubernetes Service Accounts in IAM policies. "identityNamespace": "A String", # IAM Identity Namespace to attach all Kubernetes Service Accounts to. "identityProvider": "A String", # identity provider is the third party identity provider. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. @@ -3119,7 +3123,7 @@

Method Details

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. "loadBalancerType": "A String", # Which load balancer type is installed for Cloud Run. }, - "configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted GCP services through the Kubernetes API + "configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted Google Cloud services through the Kubernetes API. "enabled": True or False, # Whether Cloud Connector is enabled for this cluster. }, "dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes @@ -3128,8 +3132,8 @@

Method Details

"gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. # Configuration for the Compute Engine Persistent Disk CSI driver. "enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster. }, - "gcpFilestoreCsiDriverConfig": { # Configuration for the GCP Filestore CSI driver. # Configuration for the GCP Filestore CSI driver. - "enabled": True or False, # Whether the GCP Filestore CSI driver is enabled for this cluster. + "gcpFilestoreCsiDriverConfig": { # Configuration for the Filestore CSI driver. # Configuration for the Filestore CSI driver. + "enabled": True or False, # Whether the Filestore CSI driver is enabled for this cluster. }, "gcsFuseCsiDriverConfig": { # Configuration for the Cloud Storage Fuse CSI driver. # Configuration for the Cloud Storage Fuse CSI driver. "enabled": True or False, # Whether the Cloud Storage Fuse CSI driver is enabled for this cluster. @@ -3294,7 +3298,9 @@

Method Details

}, "controlPlaneEndpointsConfig": { # Configuration for all of the cluster's control plane endpoints. # Configuration for all cluster's control plane endpoints. "dnsEndpointConfig": { # Describes the configuration of a DNS endpoint. # DNS endpoint configuration. - "allowExternalTraffic": True or False, # Controls whether user traffic is allowed over this endpoint. Note that GCP-managed services may still use the endpoint even if this is false. + "allowExternalTraffic": True or False, # Controls whether user traffic is allowed over this endpoint. Note that Google-managed services may still use the endpoint even if this is false. + "enableK8sCertsViaDns": True or False, # Controls whether the k8s certs auth is allowed via DNS. + "enableK8sTokensViaDns": True or False, # Controls whether the k8s token auth is allowed via DNS. "endpoint": "A String", # Output only. The cluster's DNS endpoint configuration. A DNS format address. This is accessible from the public internet. Ex: uid.us-central1.gke.goog. Always present, but the behavior may change according to the value of DNSEndpointConfig.allow_external_traffic. }, "ipEndpointsConfig": { # IP endpoints configuration. # IP endpoints configuration. @@ -3351,7 +3357,7 @@

Method Details

"enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1beta1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation. "enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. This field is deprecated, use tpu_config.enabled instead. This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25. "endpoint": "A String", # Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. - "enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. # GKE Enterprise Configuration. + "enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. Deprecated: GKE Enterprise features are now available without an Enterprise tier. # GKE Enterprise Configuration. Deprecated: GKE Enterprise features are now available without an Enterprise tier. "clusterTier": "A String", # Output only. cluster_tier indicates the effective tier of the cluster. "desiredTier": "A String", # desired_tier specifies the desired tier of the cluster. }, @@ -3591,7 +3597,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 [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/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" }, }, @@ -3865,7 +3871,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 [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/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" }, }, @@ -4005,7 +4011,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 [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/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" }, }, @@ -4403,7 +4409,7 @@

Method Details

"workloadCertificates": { # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. "enableCertificates": True or False, # enable_certificates controls issuance of workload mTLS certificates. If set, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster, which can then be configured by creating a WorkloadCertificateConfig Custom Resource. Requires Workload Identity (workload_pool must be non-empty). }, - "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. + "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in IAM policies. # Configuration for the use of Kubernetes Service Accounts in IAM policies. "identityNamespace": "A String", # IAM Identity Namespace to attach all Kubernetes Service Accounts to. "identityProvider": "A String", # identity provider is the third party identity provider. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. @@ -4432,7 +4438,7 @@

Method Details

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. "loadBalancerType": "A String", # Which load balancer type is installed for Cloud Run. }, - "configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted GCP services through the Kubernetes API + "configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted Google Cloud services through the Kubernetes API. "enabled": True or False, # Whether Cloud Connector is enabled for this cluster. }, "dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes @@ -4441,8 +4447,8 @@

Method Details

"gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. # Configuration for the Compute Engine Persistent Disk CSI driver. "enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster. }, - "gcpFilestoreCsiDriverConfig": { # Configuration for the GCP Filestore CSI driver. # Configuration for the GCP Filestore CSI driver. - "enabled": True or False, # Whether the GCP Filestore CSI driver is enabled for this cluster. + "gcpFilestoreCsiDriverConfig": { # Configuration for the Filestore CSI driver. # Configuration for the Filestore CSI driver. + "enabled": True or False, # Whether the Filestore CSI driver is enabled for this cluster. }, "gcsFuseCsiDriverConfig": { # Configuration for the Cloud Storage Fuse CSI driver. # Configuration for the Cloud Storage Fuse CSI driver. "enabled": True or False, # Whether the Cloud Storage Fuse CSI driver is enabled for this cluster. @@ -5346,7 +5352,7 @@

Method Details

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. "loadBalancerType": "A String", # Which load balancer type is installed for Cloud Run. }, - "configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted GCP services through the Kubernetes API + "configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted Google Cloud services through the Kubernetes API. "enabled": True or False, # Whether Cloud Connector is enabled for this cluster. }, "dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes @@ -5355,8 +5361,8 @@

Method Details

"gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. # Configuration for the Compute Engine Persistent Disk CSI driver. "enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster. }, - "gcpFilestoreCsiDriverConfig": { # Configuration for the GCP Filestore CSI driver. # Configuration for the GCP Filestore CSI driver. - "enabled": True or False, # Whether the GCP Filestore CSI driver is enabled for this cluster. + "gcpFilestoreCsiDriverConfig": { # Configuration for the Filestore CSI driver. # Configuration for the Filestore CSI driver. + "enabled": True or False, # Whether the Filestore CSI driver is enabled for this cluster. }, "gcsFuseCsiDriverConfig": { # Configuration for the Cloud Storage Fuse CSI driver. # Configuration for the Cloud Storage Fuse CSI driver. "enabled": True or False, # Whether the Cloud Storage Fuse CSI driver is enabled for this cluster. @@ -5503,7 +5509,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 [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/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" }, }, @@ -5513,7 +5519,9 @@

Method Details

}, "desiredControlPlaneEndpointsConfig": { # Configuration for all of the cluster's control plane endpoints. # Control plane endpoints configuration. "dnsEndpointConfig": { # Describes the configuration of a DNS endpoint. # DNS endpoint configuration. - "allowExternalTraffic": True or False, # Controls whether user traffic is allowed over this endpoint. Note that GCP-managed services may still use the endpoint even if this is false. + "allowExternalTraffic": True or False, # Controls whether user traffic is allowed over this endpoint. Note that Google-managed services may still use the endpoint even if this is false. + "enableK8sCertsViaDns": True or False, # Controls whether the k8s certs auth is allowed via DNS. + "enableK8sTokensViaDns": True or False, # Controls whether the k8s token auth is allowed via DNS. "endpoint": "A String", # Output only. The cluster's DNS endpoint configuration. A DNS format address. This is accessible from the public internet. Ex: uid.us-central1.gke.goog. Always present, but the behavior may change according to the value of DNSEndpointConfig.allow_external_traffic. }, "ipEndpointsConfig": { # IP endpoints configuration. # IP endpoints configuration. @@ -5570,7 +5578,7 @@

Method Details

"desiredEnableFqdnNetworkPolicy": True or False, # Enable/Disable FQDN Network Policy for the cluster. "desiredEnableMultiNetworking": True or False, # Enable/Disable Multi-Networking for the cluster "desiredEnablePrivateEndpoint": True or False, # Enable/Disable private endpoint for the cluster's master. Deprecated: Use desired_control_plane_endpoints_config.ip_endpoints_config.enable_public_endpoint instead. Note that the value of enable_public_endpoint is reversed: if enable_private_endpoint is false, then enable_public_endpoint will be true. - "desiredEnterpriseConfig": { # DesiredEnterpriseConfig is a wrapper used for updating enterprise_config. # The desired enterprise configuration for the cluster. + "desiredEnterpriseConfig": { # DesiredEnterpriseConfig is a wrapper used for updating enterprise_config. Deprecated: GKE Enterprise features are now available without an Enterprise tier. # The desired enterprise configuration for the cluster. Deprecated: GKE Enterprise features are now available without an Enterprise tier. "desiredTier": "A String", # desired_tier specifies the desired tier of the cluster. }, "desiredFleet": { # Fleet is the fleet configuration for the cluster. # The desired fleet configuration for the cluster. @@ -5904,7 +5912,7 @@

Method Details

"desiredWorkloadCertificates": { # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. "enableCertificates": True or False, # enable_certificates controls issuance of workload mTLS certificates. If set, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster, which can then be configured by creating a WorkloadCertificateConfig Custom Resource. Requires Workload Identity (workload_pool must be non-empty). }, - "desiredWorkloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for Workload Identity. + "desiredWorkloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in IAM policies. # Configuration for Workload Identity. "identityNamespace": "A String", # IAM Identity Namespace to attach all Kubernetes Service Accounts to. "identityProvider": "A String", # identity provider is the third party identity provider. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. diff --git a/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html b/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html index e435c4d0052..52fcb0039dc 100644 --- a/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html +++ b/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html @@ -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). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/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" }, }, @@ -757,7 +757,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 [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/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" }, }, @@ -1127,7 +1127,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 [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/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" }, }, @@ -1791,7 +1791,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 [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/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" }, }, @@ -1931,7 +1931,7 @@

Method Details

"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 [GCP 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://{$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. "labels": { # Map of node label keys and node label values. "a_key": "A String", }, diff --git a/docs/dyn/container_v1beta1.projects.zones.clusters.html b/docs/dyn/container_v1beta1.projects.zones.clusters.html index 3cd4bf09167..82d23d01410 100644 --- a/docs/dyn/container_v1beta1.projects.zones.clusters.html +++ b/docs/dyn/container_v1beta1.projects.zones.clusters.html @@ -154,7 +154,7 @@

Method Details

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. "loadBalancerType": "A String", # Which load balancer type is installed for Cloud Run. }, - "configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted GCP services through the Kubernetes API + "configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted Google Cloud services through the Kubernetes API. "enabled": True or False, # Whether Cloud Connector is enabled for this cluster. }, "dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes @@ -163,8 +163,8 @@

Method Details

"gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. # Configuration for the Compute Engine Persistent Disk CSI driver. "enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster. }, - "gcpFilestoreCsiDriverConfig": { # Configuration for the GCP Filestore CSI driver. # Configuration for the GCP Filestore CSI driver. - "enabled": True or False, # Whether the GCP Filestore CSI driver is enabled for this cluster. + "gcpFilestoreCsiDriverConfig": { # Configuration for the Filestore CSI driver. # Configuration for the Filestore CSI driver. + "enabled": True or False, # Whether the Filestore CSI driver is enabled for this cluster. }, "gcsFuseCsiDriverConfig": { # Configuration for the Cloud Storage Fuse CSI driver. # Configuration for the Cloud Storage Fuse CSI driver. "enabled": True or False, # Whether the Cloud Storage Fuse CSI driver is enabled for this cluster. @@ -382,7 +382,7 @@

Method Details

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. "loadBalancerType": "A String", # Which load balancer type is installed for Cloud Run. }, - "configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted GCP services through the Kubernetes API + "configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted Google Cloud services through the Kubernetes API. "enabled": True or False, # Whether Cloud Connector is enabled for this cluster. }, "dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes @@ -391,8 +391,8 @@

Method Details

"gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. # Configuration for the Compute Engine Persistent Disk CSI driver. "enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster. }, - "gcpFilestoreCsiDriverConfig": { # Configuration for the GCP Filestore CSI driver. # Configuration for the GCP Filestore CSI driver. - "enabled": True or False, # Whether the GCP Filestore CSI driver is enabled for this cluster. + "gcpFilestoreCsiDriverConfig": { # Configuration for the Filestore CSI driver. # Configuration for the Filestore CSI driver. + "enabled": True or False, # Whether the Filestore CSI driver is enabled for this cluster. }, "gcsFuseCsiDriverConfig": { # Configuration for the Cloud Storage Fuse CSI driver. # Configuration for the Cloud Storage Fuse CSI driver. "enabled": True or False, # Whether the Cloud Storage Fuse CSI driver is enabled for this cluster. @@ -557,7 +557,9 @@

Method Details

}, "controlPlaneEndpointsConfig": { # Configuration for all of the cluster's control plane endpoints. # Configuration for all cluster's control plane endpoints. "dnsEndpointConfig": { # Describes the configuration of a DNS endpoint. # DNS endpoint configuration. - "allowExternalTraffic": True or False, # Controls whether user traffic is allowed over this endpoint. Note that GCP-managed services may still use the endpoint even if this is false. + "allowExternalTraffic": True or False, # Controls whether user traffic is allowed over this endpoint. Note that Google-managed services may still use the endpoint even if this is false. + "enableK8sCertsViaDns": True or False, # Controls whether the k8s certs auth is allowed via DNS. + "enableK8sTokensViaDns": True or False, # Controls whether the k8s token auth is allowed via DNS. "endpoint": "A String", # Output only. The cluster's DNS endpoint configuration. A DNS format address. This is accessible from the public internet. Ex: uid.us-central1.gke.goog. Always present, but the behavior may change according to the value of DNSEndpointConfig.allow_external_traffic. }, "ipEndpointsConfig": { # IP endpoints configuration. # IP endpoints configuration. @@ -614,7 +616,7 @@

Method Details

"enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1beta1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation. "enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. This field is deprecated, use tpu_config.enabled instead. This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25. "endpoint": "A String", # Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. - "enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. # GKE Enterprise Configuration. + "enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. Deprecated: GKE Enterprise features are now available without an Enterprise tier. # GKE Enterprise Configuration. Deprecated: GKE Enterprise features are now available without an Enterprise tier. "clusterTier": "A String", # Output only. cluster_tier indicates the effective tier of the cluster. "desiredTier": "A String", # desired_tier specifies the desired tier of the cluster. }, @@ -854,7 +856,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 [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/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" }, }, @@ -1128,7 +1130,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 [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/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" }, }, @@ -1268,7 +1270,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 [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/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" }, }, @@ -1666,7 +1668,7 @@

Method Details

"workloadCertificates": { # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. "enableCertificates": True or False, # enable_certificates controls issuance of workload mTLS certificates. If set, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster, which can then be configured by creating a WorkloadCertificateConfig Custom Resource. Requires Workload Identity (workload_pool must be non-empty). }, - "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. + "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in IAM policies. # Configuration for the use of Kubernetes Service Accounts in IAM policies. "identityNamespace": "A String", # IAM Identity Namespace to attach all Kubernetes Service Accounts to. "identityProvider": "A String", # identity provider is the third party identity provider. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. @@ -1871,7 +1873,7 @@

Method Details

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. "loadBalancerType": "A String", # Which load balancer type is installed for Cloud Run. }, - "configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted GCP services through the Kubernetes API + "configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted Google Cloud services through the Kubernetes API. "enabled": True or False, # Whether Cloud Connector is enabled for this cluster. }, "dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes @@ -1880,8 +1882,8 @@

Method Details

"gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. # Configuration for the Compute Engine Persistent Disk CSI driver. "enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster. }, - "gcpFilestoreCsiDriverConfig": { # Configuration for the GCP Filestore CSI driver. # Configuration for the GCP Filestore CSI driver. - "enabled": True or False, # Whether the GCP Filestore CSI driver is enabled for this cluster. + "gcpFilestoreCsiDriverConfig": { # Configuration for the Filestore CSI driver. # Configuration for the Filestore CSI driver. + "enabled": True or False, # Whether the Filestore CSI driver is enabled for this cluster. }, "gcsFuseCsiDriverConfig": { # Configuration for the Cloud Storage Fuse CSI driver. # Configuration for the Cloud Storage Fuse CSI driver. "enabled": True or False, # Whether the Cloud Storage Fuse CSI driver is enabled for this cluster. @@ -2046,7 +2048,9 @@

Method Details

}, "controlPlaneEndpointsConfig": { # Configuration for all of the cluster's control plane endpoints. # Configuration for all cluster's control plane endpoints. "dnsEndpointConfig": { # Describes the configuration of a DNS endpoint. # DNS endpoint configuration. - "allowExternalTraffic": True or False, # Controls whether user traffic is allowed over this endpoint. Note that GCP-managed services may still use the endpoint even if this is false. + "allowExternalTraffic": True or False, # Controls whether user traffic is allowed over this endpoint. Note that Google-managed services may still use the endpoint even if this is false. + "enableK8sCertsViaDns": True or False, # Controls whether the k8s certs auth is allowed via DNS. + "enableK8sTokensViaDns": True or False, # Controls whether the k8s token auth is allowed via DNS. "endpoint": "A String", # Output only. The cluster's DNS endpoint configuration. A DNS format address. This is accessible from the public internet. Ex: uid.us-central1.gke.goog. Always present, but the behavior may change according to the value of DNSEndpointConfig.allow_external_traffic. }, "ipEndpointsConfig": { # IP endpoints configuration. # IP endpoints configuration. @@ -2103,7 +2107,7 @@

Method Details

"enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1beta1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation. "enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. This field is deprecated, use tpu_config.enabled instead. This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25. "endpoint": "A String", # Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. - "enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. # GKE Enterprise Configuration. + "enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. Deprecated: GKE Enterprise features are now available without an Enterprise tier. # GKE Enterprise Configuration. Deprecated: GKE Enterprise features are now available without an Enterprise tier. "clusterTier": "A String", # Output only. cluster_tier indicates the effective tier of the cluster. "desiredTier": "A String", # desired_tier specifies the desired tier of the cluster. }, @@ -2343,7 +2347,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 [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/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" }, }, @@ -2617,7 +2621,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 [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/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" }, }, @@ -2757,7 +2761,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 [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/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" }, }, @@ -3155,7 +3159,7 @@

Method Details

"workloadCertificates": { # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. "enableCertificates": True or False, # enable_certificates controls issuance of workload mTLS certificates. If set, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster, which can then be configured by creating a WorkloadCertificateConfig Custom Resource. Requires Workload Identity (workload_pool must be non-empty). }, - "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. + "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in IAM policies. # Configuration for the use of Kubernetes Service Accounts in IAM policies. "identityNamespace": "A String", # IAM Identity Namespace to attach all Kubernetes Service Accounts to. "identityProvider": "A String", # identity provider is the third party identity provider. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. @@ -3268,7 +3272,7 @@

Method Details

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. "loadBalancerType": "A String", # Which load balancer type is installed for Cloud Run. }, - "configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted GCP services through the Kubernetes API + "configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted Google Cloud services through the Kubernetes API. "enabled": True or False, # Whether Cloud Connector is enabled for this cluster. }, "dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes @@ -3277,8 +3281,8 @@

Method Details

"gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. # Configuration for the Compute Engine Persistent Disk CSI driver. "enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster. }, - "gcpFilestoreCsiDriverConfig": { # Configuration for the GCP Filestore CSI driver. # Configuration for the GCP Filestore CSI driver. - "enabled": True or False, # Whether the GCP Filestore CSI driver is enabled for this cluster. + "gcpFilestoreCsiDriverConfig": { # Configuration for the Filestore CSI driver. # Configuration for the Filestore CSI driver. + "enabled": True or False, # Whether the Filestore CSI driver is enabled for this cluster. }, "gcsFuseCsiDriverConfig": { # Configuration for the Cloud Storage Fuse CSI driver. # Configuration for the Cloud Storage Fuse CSI driver. "enabled": True or False, # Whether the Cloud Storage Fuse CSI driver is enabled for this cluster. @@ -3443,7 +3447,9 @@

Method Details

}, "controlPlaneEndpointsConfig": { # Configuration for all of the cluster's control plane endpoints. # Configuration for all cluster's control plane endpoints. "dnsEndpointConfig": { # Describes the configuration of a DNS endpoint. # DNS endpoint configuration. - "allowExternalTraffic": True or False, # Controls whether user traffic is allowed over this endpoint. Note that GCP-managed services may still use the endpoint even if this is false. + "allowExternalTraffic": True or False, # Controls whether user traffic is allowed over this endpoint. Note that Google-managed services may still use the endpoint even if this is false. + "enableK8sCertsViaDns": True or False, # Controls whether the k8s certs auth is allowed via DNS. + "enableK8sTokensViaDns": True or False, # Controls whether the k8s token auth is allowed via DNS. "endpoint": "A String", # Output only. The cluster's DNS endpoint configuration. A DNS format address. This is accessible from the public internet. Ex: uid.us-central1.gke.goog. Always present, but the behavior may change according to the value of DNSEndpointConfig.allow_external_traffic. }, "ipEndpointsConfig": { # IP endpoints configuration. # IP endpoints configuration. @@ -3500,7 +3506,7 @@

Method Details

"enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1beta1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation. "enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. This field is deprecated, use tpu_config.enabled instead. This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25. "endpoint": "A String", # Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. - "enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. # GKE Enterprise Configuration. + "enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. Deprecated: GKE Enterprise features are now available without an Enterprise tier. # GKE Enterprise Configuration. Deprecated: GKE Enterprise features are now available without an Enterprise tier. "clusterTier": "A String", # Output only. cluster_tier indicates the effective tier of the cluster. "desiredTier": "A String", # desired_tier specifies the desired tier of the cluster. }, @@ -3740,7 +3746,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 [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/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" }, }, @@ -4014,7 +4020,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 [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/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" }, }, @@ -4154,7 +4160,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 [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/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" }, }, @@ -4552,7 +4558,7 @@

Method Details

"workloadCertificates": { # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. "enableCertificates": True or False, # enable_certificates controls issuance of workload mTLS certificates. If set, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster, which can then be configured by creating a WorkloadCertificateConfig Custom Resource. Requires Workload Identity (workload_pool must be non-empty). }, - "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. + "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in IAM policies. # Configuration for the use of Kubernetes Service Accounts in IAM policies. "identityNamespace": "A String", # IAM Identity Namespace to attach all Kubernetes Service Accounts to. "identityProvider": "A String", # identity provider is the third party identity provider. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. @@ -5373,7 +5379,7 @@

Method Details

"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster. "loadBalancerType": "A String", # Which load balancer type is installed for Cloud Run. }, - "configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted GCP services through the Kubernetes API + "configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted Google Cloud services through the Kubernetes API. "enabled": True or False, # Whether Cloud Connector is enabled for this cluster. }, "dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes @@ -5382,8 +5388,8 @@

Method Details

"gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. # Configuration for the Compute Engine Persistent Disk CSI driver. "enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster. }, - "gcpFilestoreCsiDriverConfig": { # Configuration for the GCP Filestore CSI driver. # Configuration for the GCP Filestore CSI driver. - "enabled": True or False, # Whether the GCP Filestore CSI driver is enabled for this cluster. + "gcpFilestoreCsiDriverConfig": { # Configuration for the Filestore CSI driver. # Configuration for the Filestore CSI driver. + "enabled": True or False, # Whether the Filestore CSI driver is enabled for this cluster. }, "gcsFuseCsiDriverConfig": { # Configuration for the Cloud Storage Fuse CSI driver. # Configuration for the Cloud Storage Fuse CSI driver. "enabled": True or False, # Whether the Cloud Storage Fuse CSI driver is enabled for this cluster. @@ -5530,7 +5536,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 [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/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" }, }, @@ -5540,7 +5546,9 @@

Method Details

}, "desiredControlPlaneEndpointsConfig": { # Configuration for all of the cluster's control plane endpoints. # Control plane endpoints configuration. "dnsEndpointConfig": { # Describes the configuration of a DNS endpoint. # DNS endpoint configuration. - "allowExternalTraffic": True or False, # Controls whether user traffic is allowed over this endpoint. Note that GCP-managed services may still use the endpoint even if this is false. + "allowExternalTraffic": True or False, # Controls whether user traffic is allowed over this endpoint. Note that Google-managed services may still use the endpoint even if this is false. + "enableK8sCertsViaDns": True or False, # Controls whether the k8s certs auth is allowed via DNS. + "enableK8sTokensViaDns": True or False, # Controls whether the k8s token auth is allowed via DNS. "endpoint": "A String", # Output only. The cluster's DNS endpoint configuration. A DNS format address. This is accessible from the public internet. Ex: uid.us-central1.gke.goog. Always present, but the behavior may change according to the value of DNSEndpointConfig.allow_external_traffic. }, "ipEndpointsConfig": { # IP endpoints configuration. # IP endpoints configuration. @@ -5597,7 +5605,7 @@

Method Details

"desiredEnableFqdnNetworkPolicy": True or False, # Enable/Disable FQDN Network Policy for the cluster. "desiredEnableMultiNetworking": True or False, # Enable/Disable Multi-Networking for the cluster "desiredEnablePrivateEndpoint": True or False, # Enable/Disable private endpoint for the cluster's master. Deprecated: Use desired_control_plane_endpoints_config.ip_endpoints_config.enable_public_endpoint instead. Note that the value of enable_public_endpoint is reversed: if enable_private_endpoint is false, then enable_public_endpoint will be true. - "desiredEnterpriseConfig": { # DesiredEnterpriseConfig is a wrapper used for updating enterprise_config. # The desired enterprise configuration for the cluster. + "desiredEnterpriseConfig": { # DesiredEnterpriseConfig is a wrapper used for updating enterprise_config. Deprecated: GKE Enterprise features are now available without an Enterprise tier. # The desired enterprise configuration for the cluster. Deprecated: GKE Enterprise features are now available without an Enterprise tier. "desiredTier": "A String", # desired_tier specifies the desired tier of the cluster. }, "desiredFleet": { # Fleet is the fleet configuration for the cluster. # The desired fleet configuration for the cluster. @@ -5931,7 +5939,7 @@

Method Details

"desiredWorkloadCertificates": { # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. "enableCertificates": True or False, # enable_certificates controls issuance of workload mTLS certificates. If set, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster, which can then be configured by creating a WorkloadCertificateConfig Custom Resource. Requires Workload Identity (workload_pool must be non-empty). }, - "desiredWorkloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for Workload Identity. + "desiredWorkloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in IAM policies. # Configuration for Workload Identity. "identityNamespace": "A String", # IAM Identity Namespace to attach all Kubernetes Service Accounts to. "identityProvider": "A String", # identity provider is the third party identity provider. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. diff --git a/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html b/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html index 7ac593d746c..00b17077946 100644 --- a/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html +++ b/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html @@ -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). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/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" }, }, @@ -822,7 +822,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 [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/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" }, }, @@ -1192,7 +1192,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 [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/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" }, }, @@ -1781,7 +1781,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 [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/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" }, }, @@ -1921,7 +1921,7 @@

Method Details

"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 [GCP 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://{$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. "labels": { # Map of node label keys and node label values. "a_key": "A String", }, diff --git a/googleapiclient/discovery_cache/documents/container.v1beta1.json b/googleapiclient/discovery_cache/documents/container.v1beta1.json index 31f849f3581..93d600c4b64 100644 --- a/googleapiclient/discovery_cache/documents/container.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/container.v1beta1.json @@ -2685,7 +2685,7 @@ } } }, -"revision": "20250819", +"revision": "20250916", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2810,7 +2810,7 @@ }, "configConnectorConfig": { "$ref": "ConfigConnectorConfig", -"description": "Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted GCP services through the Kubernetes API" +"description": "Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted Google Cloud services through the Kubernetes API." }, "dnsCacheConfig": { "$ref": "DnsCacheConfig", @@ -2822,7 +2822,7 @@ }, "gcpFilestoreCsiDriverConfig": { "$ref": "GcpFilestoreCsiDriverConfig", -"description": "Configuration for the GCP Filestore CSI driver." +"description": "Configuration for the Filestore CSI driver." }, "gcsFuseCsiDriverConfig": { "$ref": "GcsFuseCsiDriverConfig", @@ -3414,7 +3414,7 @@ }, "gcpSecretManagerCertificateConfig": { "$ref": "GCPSecretManagerCertificateConfig", -"description": "Google Secret Manager (GCP) certificate configuration." +"description": "Secret Manager certificate configuration." } }, "type": "object" @@ -3609,7 +3609,8 @@ }, "enterpriseConfig": { "$ref": "EnterpriseConfig", -"description": "GKE Enterprise Configuration." +"deprecated": true, +"description": "GKE Enterprise Configuration. Deprecated: GKE Enterprise features are now available without an Enterprise tier." }, "etag": { "description": "This checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.", @@ -3907,7 +3908,7 @@ }, "workloadIdentityConfig": { "$ref": "WorkloadIdentityConfig", -"description": "Configuration for the use of Kubernetes Service Accounts in GCP IAM policies." +"description": "Configuration for the use of Kubernetes Service Accounts in IAM policies." }, "zone": { "deprecated": true, @@ -4120,7 +4121,8 @@ }, "desiredEnterpriseConfig": { "$ref": "DesiredEnterpriseConfig", -"description": "The desired enterprise configuration for the cluster." +"deprecated": true, +"description": "The desired enterprise configuration for the cluster. Deprecated: GKE Enterprise features are now available without an Enterprise tier." }, "desiredFleet": { "$ref": "Fleet", @@ -4730,7 +4732,15 @@ "id": "DNSEndpointConfig", "properties": { "allowExternalTraffic": { -"description": "Controls whether user traffic is allowed over this endpoint. Note that GCP-managed services may still use the endpoint even if this is false.", +"description": "Controls whether user traffic is allowed over this endpoint. Note that Google-managed services may still use the endpoint even if this is false.", +"type": "boolean" +}, +"enableK8sCertsViaDns": { +"description": "Controls whether the k8s certs auth is allowed via DNS.", +"type": "boolean" +}, +"enableK8sTokensViaDns": { +"description": "Controls whether the k8s token auth is allowed via DNS.", "type": "boolean" }, "endpoint": { @@ -4880,7 +4890,8 @@ "type": "object" }, "DesiredEnterpriseConfig": { -"description": "DesiredEnterpriseConfig is a wrapper used for updating enterprise_config.", +"deprecated": true, +"description": "DesiredEnterpriseConfig is a wrapper used for updating enterprise_config. Deprecated: GKE Enterprise features are now available without an Enterprise tier.", "id": "DesiredEnterpriseConfig", "properties": { "desiredTier": { @@ -4918,7 +4929,8 @@ "type": "object" }, "EnterpriseConfig": { -"description": "EnterpriseConfig is the cluster enterprise configuration.", +"deprecated": true, +"description": "EnterpriseConfig is the cluster enterprise configuration. Deprecated: GKE Enterprise features are now available without an Enterprise tier.", "id": "EnterpriseConfig", "properties": { "clusterTier": { @@ -5259,11 +5271,11 @@ false "type": "object" }, "GcpFilestoreCsiDriverConfig": { -"description": "Configuration for the GCP Filestore CSI driver.", +"description": "Configuration for the Filestore CSI driver.", "id": "GcpFilestoreCsiDriverConfig", "properties": { "enabled": { -"description": "Whether the GCP Filestore CSI driver is enabled for this cluster.", +"description": "Whether the Filestore CSI driver is enabled for this cluster.", "type": "boolean" } }, @@ -5841,7 +5853,7 @@ false "enumDescriptions": [ "Default value. GKE will not modify the kernel configuration.", "It means that an application requesting THP will stall on allocation failure and directly reclaim pages and compact memory in an effort to allocate a THP immediately.", -"It means that an application will wake kswapd in the background to reclaim pages and wake kcompactd to compact memory so that THP is available in the near future. It\u2019s the responsibility of khugepaged to then install the THP pages later.", +"It means that an application will wake kswapd in the background to reclaim pages and wake kcompactd to compact memory so that THP is available in the near future. It's the responsibility of khugepaged to then install the THP pages later.", "It means that an application will enter direct reclaim and compaction like always, but only for regions that have used madvise(MADV_HUGEPAGE); all other regions will wake kswapd in the background to reclaim pages and wake kcompactd to compact memory so that THP is available in the near future.", "It means that an application will enter direct reclaim like always but only for regions that are have used madvise(MADV_HUGEPAGE). This is the default kernel configuration.", "It means that an application will never enter direct reclaim or compaction." @@ -8133,7 +8145,7 @@ false "type": "object" }, "ResourceLabels": { -"description": "Collection of [GCP labels](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-labels).", +"description": "Collection of [Resource Manager labels](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-labels).", "id": "ResourceLabels", "properties": { "labels": { @@ -9892,7 +9904,7 @@ true "type": "object" }, "WorkloadIdentityConfig": { -"description": "Configuration for the use of Kubernetes Service Accounts in GCP IAM policies.", +"description": "Configuration for the use of Kubernetes Service Accounts in IAM policies.", "id": "WorkloadIdentityConfig", "properties": { "identityNamespace": { From 64b88544581231cd164dd9faa4d146924f1d16ee Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 30 Sep 2025 07:09:35 +0000 Subject: [PATCH 14/42] fix(dataflow): update the api #### dataflow:v1b3 The following keys were changed: - endpoints (Total Keys: 1) --- .../discovery_cache/documents/dataflow.v1b3.json | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/googleapiclient/discovery_cache/documents/dataflow.v1b3.json b/googleapiclient/discovery_cache/documents/dataflow.v1b3.json index 858f1d8929e..51c6dbbb6be 100644 --- a/googleapiclient/discovery_cache/documents/dataflow.v1b3.json +++ b/googleapiclient/discovery_cache/documents/dataflow.v1b3.json @@ -21,6 +21,16 @@ "endpoints": [ { "description": "Regional Endpoint", +"endpointUrl": "https://dataflow.asia-south1.rep.googleapis.com/", +"location": "asia-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataflow.asia-south2.rep.googleapis.com/", +"location": "asia-south2" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://dataflow.europe-west3.rep.googleapis.com/", "location": "europe-west3" }, @@ -2250,7 +2260,7 @@ } } }, -"revision": "20250825", +"revision": "20250922", "rootUrl": "https://dataflow.googleapis.com/", "schemas": { "ApproximateProgress": { From 350d08137cd8f43fcbc473d77bcf693a2e00d917 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 30 Sep 2025 07:09:35 +0000 Subject: [PATCH 15/42] fix(datastore): update the api #### datastore:v1 The following keys were changed: - endpoints (Total Keys: 1) #### datastore:v1beta1 The following keys were changed: - endpoints (Total Keys: 1) #### datastore:v1beta3 The following keys were changed: - endpoints (Total Keys: 1) --- .../documents/datastore.v1.json | 432 +++++++++++++++++- .../documents/datastore.v1beta1.json | 432 +++++++++++++++++- .../documents/datastore.v1beta3.json | 432 +++++++++++++++++- 3 files changed, 1293 insertions(+), 3 deletions(-) diff --git a/googleapiclient/discovery_cache/documents/datastore.v1.json b/googleapiclient/discovery_cache/documents/datastore.v1.json index 5f08e37375c..58d354fc086 100644 --- a/googleapiclient/discovery_cache/documents/datastore.v1.json +++ b/googleapiclient/discovery_cache/documents/datastore.v1.json @@ -20,13 +20,443 @@ "endpoints": [ { "description": "Regional Endpoint", +"endpointUrl": "https://datastore.africa-south1.rep.googleapis.com/", +"location": "africa-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.asia-east1.rep.googleapis.com/", +"location": "asia-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.asia-east2.rep.googleapis.com/", +"location": "asia-east2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.asia-northeast1.rep.googleapis.com/", +"location": "asia-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.asia-northeast2.rep.googleapis.com/", +"location": "asia-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.asia-northeast3.rep.googleapis.com/", +"location": "asia-northeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.asia-south1.rep.googleapis.com/", +"location": "asia-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.asia-south2.rep.googleapis.com/", +"location": "asia-south2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.asia-southeast1.rep.googleapis.com/", +"location": "asia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.asia-southeast2.rep.googleapis.com/", +"location": "asia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.australia-southeast1.rep.googleapis.com/", +"location": "australia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.australia-southeast2.rep.googleapis.com/", +"location": "australia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.europe-central2.rep.googleapis.com/", +"location": "europe-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.europe-north1.rep.googleapis.com/", +"location": "europe-north1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.europe-north2.rep.googleapis.com/", +"location": "europe-north2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.europe-southwest1.rep.googleapis.com/", +"location": "europe-southwest1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.europe-west1.rep.googleapis.com/", +"location": "europe-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.europe-west10.rep.googleapis.com/", +"location": "europe-west10" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.europe-west12.rep.googleapis.com/", +"location": "europe-west12" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.europe-west2.rep.googleapis.com/", +"location": "europe-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.europe-west3.rep.googleapis.com/", +"location": "europe-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.europe-west4.rep.googleapis.com/", +"location": "europe-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.europe-west6.rep.googleapis.com/", +"location": "europe-west6" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.europe-west8.rep.googleapis.com/", +"location": "europe-west8" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.europe-west9.rep.googleapis.com/", +"location": "europe-west9" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.me-central1.rep.googleapis.com/", +"location": "me-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.me-central2.rep.googleapis.com/", +"location": "me-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.me-west1.rep.googleapis.com/", +"location": "me-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.northamerica-northeast1.rep.googleapis.com/", +"location": "northamerica-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.northamerica-northeast2.rep.googleapis.com/", +"location": "northamerica-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.northamerica-south1.rep.googleapis.com/", +"location": "northamerica-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.southamerica-east1.rep.googleapis.com/", +"location": "southamerica-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.southamerica-west1.rep.googleapis.com/", +"location": "southamerica-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.us-central1.rep.googleapis.com/", +"location": "us-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.us-east1.rep.googleapis.com/", +"location": "us-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.us-east4.rep.googleapis.com/", +"location": "us-east4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.us-east5.rep.googleapis.com/", +"location": "us-east5" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://datastore.us-east7.rep.googleapis.com/", "location": "us-east7" }, { "description": "Regional Endpoint", +"endpointUrl": "https://datastore.us-south1.rep.googleapis.com/", +"location": "us-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.us-west1.rep.googleapis.com/", +"location": "us-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.us-west2.rep.googleapis.com/", +"location": "us-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.us-west3.rep.googleapis.com/", +"location": "us-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.us-west4.rep.googleapis.com/", +"location": "us-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.us-west8.rep.googleapis.com/", +"location": "us-west8" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.africa-south1.rep.googleapis.com/", +"location": "africa-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.asia-east1.rep.googleapis.com/", +"location": "asia-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.asia-east2.rep.googleapis.com/", +"location": "asia-east2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.asia-northeast1.rep.googleapis.com/", +"location": "asia-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.asia-northeast2.rep.googleapis.com/", +"location": "asia-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.asia-northeast3.rep.googleapis.com/", +"location": "asia-northeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.asia-south1.rep.googleapis.com/", +"location": "asia-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.asia-south2.rep.googleapis.com/", +"location": "asia-south2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.asia-southeast1.rep.googleapis.com/", +"location": "asia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.asia-southeast2.rep.googleapis.com/", +"location": "asia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.australia-southeast1.rep.googleapis.com/", +"location": "australia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.australia-southeast2.rep.googleapis.com/", +"location": "australia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.europe-central2.rep.googleapis.com/", +"location": "europe-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.europe-north1.rep.googleapis.com/", +"location": "europe-north1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.europe-north2.rep.googleapis.com/", +"location": "europe-north2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.europe-southwest1.rep.googleapis.com/", +"location": "europe-southwest1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.europe-west1.rep.googleapis.com/", +"location": "europe-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.europe-west10.rep.googleapis.com/", +"location": "europe-west10" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.europe-west12.rep.googleapis.com/", +"location": "europe-west12" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.europe-west2.rep.googleapis.com/", +"location": "europe-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.europe-west3.rep.googleapis.com/", +"location": "europe-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.europe-west4.rep.googleapis.com/", +"location": "europe-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.europe-west6.rep.googleapis.com/", +"location": "europe-west6" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.europe-west8.rep.googleapis.com/", +"location": "europe-west8" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.europe-west9.rep.googleapis.com/", +"location": "europe-west9" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.me-central1.rep.googleapis.com/", +"location": "me-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.me-central2.rep.googleapis.com/", +"location": "me-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.me-west1.rep.googleapis.com/", +"location": "me-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.northamerica-northeast1.rep.googleapis.com/", +"location": "northamerica-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.northamerica-northeast2.rep.googleapis.com/", +"location": "northamerica-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.northamerica-south1.rep.googleapis.com/", +"location": "northamerica-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.southamerica-east1.rep.googleapis.com/", +"location": "southamerica-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.southamerica-west1.rep.googleapis.com/", +"location": "southamerica-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.us-central1.rep.googleapis.com/", +"location": "us-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.us-east1.rep.googleapis.com/", +"location": "us-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.us-east4.rep.googleapis.com/", +"location": "us-east4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.us-east5.rep.googleapis.com/", +"location": "us-east5" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://batch-datastore.us-east7.rep.googleapis.com/", "location": "us-east7" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.us-south1.rep.googleapis.com/", +"location": "us-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.us-west1.rep.googleapis.com/", +"location": "us-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.us-west2.rep.googleapis.com/", +"location": "us-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.us-west3.rep.googleapis.com/", +"location": "us-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.us-west4.rep.googleapis.com/", +"location": "us-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.us-west8.rep.googleapis.com/", +"location": "us-west8" } ], "fullyEncodeReservedExpansion": true, @@ -666,7 +1096,7 @@ } } }, -"revision": "20250830", +"revision": "20250918", "rootUrl": "https://datastore.googleapis.com/", "schemas": { "Aggregation": { diff --git a/googleapiclient/discovery_cache/documents/datastore.v1beta1.json b/googleapiclient/discovery_cache/documents/datastore.v1beta1.json index e9c3200248a..54fa804768a 100644 --- a/googleapiclient/discovery_cache/documents/datastore.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/datastore.v1beta1.json @@ -20,13 +20,443 @@ "endpoints": [ { "description": "Regional Endpoint", +"endpointUrl": "https://datastore.africa-south1.rep.googleapis.com/", +"location": "africa-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.asia-east1.rep.googleapis.com/", +"location": "asia-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.asia-east2.rep.googleapis.com/", +"location": "asia-east2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.asia-northeast1.rep.googleapis.com/", +"location": "asia-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.asia-northeast2.rep.googleapis.com/", +"location": "asia-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.asia-northeast3.rep.googleapis.com/", +"location": "asia-northeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.asia-south1.rep.googleapis.com/", +"location": "asia-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.asia-south2.rep.googleapis.com/", +"location": "asia-south2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.asia-southeast1.rep.googleapis.com/", +"location": "asia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.asia-southeast2.rep.googleapis.com/", +"location": "asia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.australia-southeast1.rep.googleapis.com/", +"location": "australia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.australia-southeast2.rep.googleapis.com/", +"location": "australia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.europe-central2.rep.googleapis.com/", +"location": "europe-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.europe-north1.rep.googleapis.com/", +"location": "europe-north1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.europe-north2.rep.googleapis.com/", +"location": "europe-north2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.europe-southwest1.rep.googleapis.com/", +"location": "europe-southwest1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.europe-west1.rep.googleapis.com/", +"location": "europe-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.europe-west10.rep.googleapis.com/", +"location": "europe-west10" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.europe-west12.rep.googleapis.com/", +"location": "europe-west12" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.europe-west2.rep.googleapis.com/", +"location": "europe-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.europe-west3.rep.googleapis.com/", +"location": "europe-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.europe-west4.rep.googleapis.com/", +"location": "europe-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.europe-west6.rep.googleapis.com/", +"location": "europe-west6" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.europe-west8.rep.googleapis.com/", +"location": "europe-west8" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.europe-west9.rep.googleapis.com/", +"location": "europe-west9" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.me-central1.rep.googleapis.com/", +"location": "me-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.me-central2.rep.googleapis.com/", +"location": "me-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.me-west1.rep.googleapis.com/", +"location": "me-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.northamerica-northeast1.rep.googleapis.com/", +"location": "northamerica-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.northamerica-northeast2.rep.googleapis.com/", +"location": "northamerica-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.northamerica-south1.rep.googleapis.com/", +"location": "northamerica-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.southamerica-east1.rep.googleapis.com/", +"location": "southamerica-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.southamerica-west1.rep.googleapis.com/", +"location": "southamerica-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.us-central1.rep.googleapis.com/", +"location": "us-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.us-east1.rep.googleapis.com/", +"location": "us-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.us-east4.rep.googleapis.com/", +"location": "us-east4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.us-east5.rep.googleapis.com/", +"location": "us-east5" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://datastore.us-east7.rep.googleapis.com/", "location": "us-east7" }, { "description": "Regional Endpoint", +"endpointUrl": "https://datastore.us-south1.rep.googleapis.com/", +"location": "us-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.us-west1.rep.googleapis.com/", +"location": "us-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.us-west2.rep.googleapis.com/", +"location": "us-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.us-west3.rep.googleapis.com/", +"location": "us-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.us-west4.rep.googleapis.com/", +"location": "us-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.us-west8.rep.googleapis.com/", +"location": "us-west8" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.africa-south1.rep.googleapis.com/", +"location": "africa-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.asia-east1.rep.googleapis.com/", +"location": "asia-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.asia-east2.rep.googleapis.com/", +"location": "asia-east2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.asia-northeast1.rep.googleapis.com/", +"location": "asia-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.asia-northeast2.rep.googleapis.com/", +"location": "asia-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.asia-northeast3.rep.googleapis.com/", +"location": "asia-northeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.asia-south1.rep.googleapis.com/", +"location": "asia-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.asia-south2.rep.googleapis.com/", +"location": "asia-south2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.asia-southeast1.rep.googleapis.com/", +"location": "asia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.asia-southeast2.rep.googleapis.com/", +"location": "asia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.australia-southeast1.rep.googleapis.com/", +"location": "australia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.australia-southeast2.rep.googleapis.com/", +"location": "australia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.europe-central2.rep.googleapis.com/", +"location": "europe-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.europe-north1.rep.googleapis.com/", +"location": "europe-north1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.europe-north2.rep.googleapis.com/", +"location": "europe-north2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.europe-southwest1.rep.googleapis.com/", +"location": "europe-southwest1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.europe-west1.rep.googleapis.com/", +"location": "europe-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.europe-west10.rep.googleapis.com/", +"location": "europe-west10" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.europe-west12.rep.googleapis.com/", +"location": "europe-west12" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.europe-west2.rep.googleapis.com/", +"location": "europe-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.europe-west3.rep.googleapis.com/", +"location": "europe-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.europe-west4.rep.googleapis.com/", +"location": "europe-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.europe-west6.rep.googleapis.com/", +"location": "europe-west6" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.europe-west8.rep.googleapis.com/", +"location": "europe-west8" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.europe-west9.rep.googleapis.com/", +"location": "europe-west9" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.me-central1.rep.googleapis.com/", +"location": "me-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.me-central2.rep.googleapis.com/", +"location": "me-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.me-west1.rep.googleapis.com/", +"location": "me-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.northamerica-northeast1.rep.googleapis.com/", +"location": "northamerica-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.northamerica-northeast2.rep.googleapis.com/", +"location": "northamerica-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.northamerica-south1.rep.googleapis.com/", +"location": "northamerica-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.southamerica-east1.rep.googleapis.com/", +"location": "southamerica-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.southamerica-west1.rep.googleapis.com/", +"location": "southamerica-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.us-central1.rep.googleapis.com/", +"location": "us-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.us-east1.rep.googleapis.com/", +"location": "us-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.us-east4.rep.googleapis.com/", +"location": "us-east4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.us-east5.rep.googleapis.com/", +"location": "us-east5" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://batch-datastore.us-east7.rep.googleapis.com/", "location": "us-east7" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.us-south1.rep.googleapis.com/", +"location": "us-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.us-west1.rep.googleapis.com/", +"location": "us-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.us-west2.rep.googleapis.com/", +"location": "us-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.us-west3.rep.googleapis.com/", +"location": "us-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.us-west4.rep.googleapis.com/", +"location": "us-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.us-west8.rep.googleapis.com/", +"location": "us-west8" } ], "fullyEncodeReservedExpansion": true, @@ -180,7 +610,7 @@ } } }, -"revision": "20250830", +"revision": "20250918", "rootUrl": "https://datastore.googleapis.com/", "schemas": { "GoogleDatastoreAdminV1CommonMetadata": { diff --git a/googleapiclient/discovery_cache/documents/datastore.v1beta3.json b/googleapiclient/discovery_cache/documents/datastore.v1beta3.json index e5e71db314d..2c80b3f86de 100644 --- a/googleapiclient/discovery_cache/documents/datastore.v1beta3.json +++ b/googleapiclient/discovery_cache/documents/datastore.v1beta3.json @@ -20,13 +20,443 @@ "endpoints": [ { "description": "Regional Endpoint", +"endpointUrl": "https://datastore.africa-south1.rep.googleapis.com/", +"location": "africa-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.asia-east1.rep.googleapis.com/", +"location": "asia-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.asia-east2.rep.googleapis.com/", +"location": "asia-east2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.asia-northeast1.rep.googleapis.com/", +"location": "asia-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.asia-northeast2.rep.googleapis.com/", +"location": "asia-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.asia-northeast3.rep.googleapis.com/", +"location": "asia-northeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.asia-south1.rep.googleapis.com/", +"location": "asia-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.asia-south2.rep.googleapis.com/", +"location": "asia-south2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.asia-southeast1.rep.googleapis.com/", +"location": "asia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.asia-southeast2.rep.googleapis.com/", +"location": "asia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.australia-southeast1.rep.googleapis.com/", +"location": "australia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.australia-southeast2.rep.googleapis.com/", +"location": "australia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.europe-central2.rep.googleapis.com/", +"location": "europe-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.europe-north1.rep.googleapis.com/", +"location": "europe-north1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.europe-north2.rep.googleapis.com/", +"location": "europe-north2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.europe-southwest1.rep.googleapis.com/", +"location": "europe-southwest1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.europe-west1.rep.googleapis.com/", +"location": "europe-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.europe-west10.rep.googleapis.com/", +"location": "europe-west10" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.europe-west12.rep.googleapis.com/", +"location": "europe-west12" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.europe-west2.rep.googleapis.com/", +"location": "europe-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.europe-west3.rep.googleapis.com/", +"location": "europe-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.europe-west4.rep.googleapis.com/", +"location": "europe-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.europe-west6.rep.googleapis.com/", +"location": "europe-west6" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.europe-west8.rep.googleapis.com/", +"location": "europe-west8" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.europe-west9.rep.googleapis.com/", +"location": "europe-west9" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.me-central1.rep.googleapis.com/", +"location": "me-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.me-central2.rep.googleapis.com/", +"location": "me-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.me-west1.rep.googleapis.com/", +"location": "me-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.northamerica-northeast1.rep.googleapis.com/", +"location": "northamerica-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.northamerica-northeast2.rep.googleapis.com/", +"location": "northamerica-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.northamerica-south1.rep.googleapis.com/", +"location": "northamerica-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.southamerica-east1.rep.googleapis.com/", +"location": "southamerica-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.southamerica-west1.rep.googleapis.com/", +"location": "southamerica-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.us-central1.rep.googleapis.com/", +"location": "us-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.us-east1.rep.googleapis.com/", +"location": "us-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.us-east4.rep.googleapis.com/", +"location": "us-east4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.us-east5.rep.googleapis.com/", +"location": "us-east5" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://datastore.us-east7.rep.googleapis.com/", "location": "us-east7" }, { "description": "Regional Endpoint", +"endpointUrl": "https://datastore.us-south1.rep.googleapis.com/", +"location": "us-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.us-west1.rep.googleapis.com/", +"location": "us-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.us-west2.rep.googleapis.com/", +"location": "us-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.us-west3.rep.googleapis.com/", +"location": "us-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.us-west4.rep.googleapis.com/", +"location": "us-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://datastore.us-west8.rep.googleapis.com/", +"location": "us-west8" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.africa-south1.rep.googleapis.com/", +"location": "africa-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.asia-east1.rep.googleapis.com/", +"location": "asia-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.asia-east2.rep.googleapis.com/", +"location": "asia-east2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.asia-northeast1.rep.googleapis.com/", +"location": "asia-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.asia-northeast2.rep.googleapis.com/", +"location": "asia-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.asia-northeast3.rep.googleapis.com/", +"location": "asia-northeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.asia-south1.rep.googleapis.com/", +"location": "asia-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.asia-south2.rep.googleapis.com/", +"location": "asia-south2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.asia-southeast1.rep.googleapis.com/", +"location": "asia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.asia-southeast2.rep.googleapis.com/", +"location": "asia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.australia-southeast1.rep.googleapis.com/", +"location": "australia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.australia-southeast2.rep.googleapis.com/", +"location": "australia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.europe-central2.rep.googleapis.com/", +"location": "europe-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.europe-north1.rep.googleapis.com/", +"location": "europe-north1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.europe-north2.rep.googleapis.com/", +"location": "europe-north2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.europe-southwest1.rep.googleapis.com/", +"location": "europe-southwest1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.europe-west1.rep.googleapis.com/", +"location": "europe-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.europe-west10.rep.googleapis.com/", +"location": "europe-west10" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.europe-west12.rep.googleapis.com/", +"location": "europe-west12" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.europe-west2.rep.googleapis.com/", +"location": "europe-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.europe-west3.rep.googleapis.com/", +"location": "europe-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.europe-west4.rep.googleapis.com/", +"location": "europe-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.europe-west6.rep.googleapis.com/", +"location": "europe-west6" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.europe-west8.rep.googleapis.com/", +"location": "europe-west8" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.europe-west9.rep.googleapis.com/", +"location": "europe-west9" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.me-central1.rep.googleapis.com/", +"location": "me-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.me-central2.rep.googleapis.com/", +"location": "me-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.me-west1.rep.googleapis.com/", +"location": "me-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.northamerica-northeast1.rep.googleapis.com/", +"location": "northamerica-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.northamerica-northeast2.rep.googleapis.com/", +"location": "northamerica-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.northamerica-south1.rep.googleapis.com/", +"location": "northamerica-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.southamerica-east1.rep.googleapis.com/", +"location": "southamerica-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.southamerica-west1.rep.googleapis.com/", +"location": "southamerica-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.us-central1.rep.googleapis.com/", +"location": "us-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.us-east1.rep.googleapis.com/", +"location": "us-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.us-east4.rep.googleapis.com/", +"location": "us-east4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.us-east5.rep.googleapis.com/", +"location": "us-east5" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://batch-datastore.us-east7.rep.googleapis.com/", "location": "us-east7" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.us-south1.rep.googleapis.com/", +"location": "us-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.us-west1.rep.googleapis.com/", +"location": "us-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.us-west2.rep.googleapis.com/", +"location": "us-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.us-west3.rep.googleapis.com/", +"location": "us-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.us-west4.rep.googleapis.com/", +"location": "us-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-datastore.us-west8.rep.googleapis.com/", +"location": "us-west8" } ], "fullyEncodeReservedExpansion": true, @@ -348,7 +778,7 @@ } } }, -"revision": "20250830", +"revision": "20250918", "rootUrl": "https://datastore.googleapis.com/", "schemas": { "Aggregation": { From 18f204690386d9d5c111a01ad321a50f240266cf Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 30 Sep 2025 07:09:35 +0000 Subject: [PATCH 16/42] feat(dialogflow): update the api #### dialogflow:v2 The following keys were added: - resources.projects.resources.locations.resources.generators.resources.evaluations.methods.create (Total Keys: 12) - resources.projects.resources.locations.resources.generators.resources.evaluations.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.generators.resources.evaluations.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.generators.resources.evaluations.methods.list (Total Keys: 16) - schemas.GoogleCloudDialogflowV2EvaluationStatus (Total Keys: 6) - schemas.GoogleCloudDialogflowV2GeneratorEvaluation (Total Keys: 60) - schemas.GoogleCloudDialogflowV2ListGeneratorEvaluationsResponse (Total Keys: 5) - schemas.GoogleCloudDialogflowV2SummarizationEvaluationMetrics (Total Keys: 125) #### dialogflow:v2beta1 The following keys were added: - resources.projects.resources.locations.resources.generators.resources.evaluations.methods.create (Total Keys: 12) - resources.projects.resources.locations.resources.generators.resources.evaluations.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.generators.resources.evaluations.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.generators.resources.evaluations.methods.list (Total Keys: 16) - schemas.GoogleCloudDialogflowV2beta1EvaluationStatus (Total Keys: 6) - schemas.GoogleCloudDialogflowV2beta1GeneratorEvaluation (Total Keys: 60) - schemas.GoogleCloudDialogflowV2beta1ListGeneratorEvaluationsResponse (Total Keys: 5) - schemas.GoogleCloudDialogflowV2beta1SummarizationEvaluationMetrics (Total Keys: 125) --- ...ects.locations.generators.evaluations.html | 946 ++++++++++++++++++ ...flow_v2.projects.locations.generators.html | 5 + .../dyn/dialogflow_v2.projects.locations.html | 2 +- ...ects.locations.generators.evaluations.html | 946 ++++++++++++++++++ ...v2beta1.projects.locations.generators.html | 5 + ...dialogflow_v2beta1.projects.locations.html | 2 +- .../dyn/dialogflow_v3.projects.locations.html | 2 +- ...dialogflow_v3beta1.projects.locations.html | 2 +- .../documents/dialogflow.v2.json | 696 ++++++++++++- .../documents/dialogflow.v2beta1.json | 708 ++++++++++++- .../documents/dialogflow.v3.json | 4 +- .../documents/dialogflow.v3beta1.json | 4 +- 12 files changed, 3304 insertions(+), 18 deletions(-) create mode 100644 docs/dyn/dialogflow_v2.projects.locations.generators.evaluations.html create mode 100644 docs/dyn/dialogflow_v2beta1.projects.locations.generators.evaluations.html diff --git a/docs/dyn/dialogflow_v2.projects.locations.generators.evaluations.html b/docs/dyn/dialogflow_v2.projects.locations.generators.evaluations.html new file mode 100644 index 00000000000..fa924ca31b5 --- /dev/null +++ b/docs/dyn/dialogflow_v2.projects.locations.generators.evaluations.html @@ -0,0 +1,946 @@ + + + +

Dialogflow API . projects . locations . generators . evaluations

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, x__xgafv=None)

+

Creates evaluation of a generator.

+

+ delete(name, x__xgafv=None)

+

Deletes an evaluation of generator.

+

+ get(name, x__xgafv=None)

+

Gets an evaluation of generator.

+

+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists evaluations of generator.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) + 
Creates evaluation of a generator.
+
+Args:
+  parent: string, Required. The generator resource name. Format: `projects//locations//generators/` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents evaluation result of a generator.
+  "completeTime": "A String", # Output only. Completion time of this generator evaluation.
+  "createTime": "A String", # Output only. Creation time of this generator evaluation.
+  "displayName": "A String", # Optional. The display name of the generator evaluation. At most 64 bytes long.
+  "evaluationStatus": { # A common evalaution pipeline status. # Output only. The result status of the evaluation pipeline. Provides the status information including if the evaluation is still in progress, completed or failed with certain error and user actionable message.
+    "done": True or False, # Output only. If the value is `false`, it means the evaluation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+    "pipelineStatus": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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 result of the evaluation in case of failure in evaluation pipeline.
+      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+      "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+        {
+          "a_key": "", # Properties of the object. Contains field @type with type URL.
+        },
+      ],
+      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+    },
+  },
+  "generatorEvaluationConfig": { # Generator evaluation input config. # Required. The configuration of the evaluation task.
+    "inputDataConfig": { # Input data config details # Required. The config/source of input data.
+      "agentAssistInputDataConfig": { # The distinctive configs for Agent Assist conversations as the conversation source. # The distinctive configs for Agent Assist conversations as the conversation source.
+        "endTime": "A String", # Required. The end of the time range for conversations to be evaluated. Only conversations ended at or before this timestamp will be sampled.
+        "startTime": "A String", # Required. The start of the time range for conversations to be evaluated. Only conversations created at or after this timestamp will be sampled.
+      },
+      "datasetInputDataConfig": { # The distinctive configs for dataset as the conversation source. # The distinctive configs for dataset as the conversation source.
+        "dataset": "A String", # Required. The identifier of the dataset to be evaluated. Format: `projects//locations//datasets/`.
+      },
+      "endTime": "A String", # Optional. The end timestamp to fetch conversation data.
+      "inputDataSourceType": "A String", # Required. The source type of input data.
+      "isSummaryGenerationAllowed": True or False, # Optional. Whether the summary generation is allowed when the pre-existing qualified summaries are insufficient to cover the sample size.
+      "sampleSize": 42, # Optional. Desired number of conversation-summary pairs to be evaluated.
+      "startTime": "A String", # Optional. The start timestamp to fetch conversation data.
+      "summaryGenerationOption": "A String", # Optional. Option to control whether summaries are generated during evaluation.
+    },
+    "outputGcsBucketPath": "A String", # Required. The output Cloud Storage bucket path to store eval files, e.g. per_summary_accuracy_score report. This path is provided by customer and files stored in it are visible to customer, no internal data should be stored in this path.
+    "summarizationConfig": { # Evaluation configs for summarization generator. # Evaluation configs for summarization generator.
+      "accuracyEvaluationVersion": "A String", # Optional. Version for summarization accuracy. This will determine the prompt and model used at backend.
+      "completenessEvaluationVersion": "A String", # Optional. Version for summarization completeness. This will determine the prompt and model used at backend.
+      "enableAccuracyEvaluation": True or False, # Optional. Enable accuracy evaluation.
+      "enableCompletenessEvaluation": True or False, # Optional. Enable completeness evaluation.
+      "evaluatorVersion": "A String", # Output only. Version for summarization evaluation.
+    },
+  },
+  "initialGenerator": { # LLM generator. # Required. The initial generator that was used when creating this evaluation. This is a copy of the generator read from storage when creating the evaluation.
+    "createTime": "A String", # Output only. Creation time of this generator.
+    "description": "A String", # Optional. Human readable description of the generator.
+    "freeFormContext": { # Free form generator context that customer can configure. # Input of free from generator to LLM.
+      "text": "A String", # Optional. Free form text input to LLM.
+    },
+    "inferenceParameter": { # The parameters of inference. # Optional. Inference parameters for this generator.
+      "maxOutputTokens": 42, # Optional. Maximum number of the output tokens for the generator.
+      "temperature": 3.14, # Optional. Controls the randomness of LLM predictions. Low temperature = less random. High temperature = more random. If unset (or 0), uses a default value of 0.
+      "topK": 42, # Optional. Top-k changes how the model selects tokens for output. A top-k of 1 means the selected token is the most probable among all tokens in the model's vocabulary (also called greedy decoding), while a top-k of 3 means that the next token is selected from among the 3 most probable tokens (using temperature). For each token selection step, the top K tokens with the highest probabilities are sampled. Then tokens are further filtered based on topP with the final token selected using temperature sampling. Specify a lower value for less random responses and a higher value for more random responses. Acceptable value is [1, 40], default to 40.
+      "topP": 3.14, # Optional. Top-p changes how the model selects tokens for output. Tokens are selected from most K (see topK parameter) probable to least until the sum of their probabilities equals the top-p value. For example, if tokens A, B, and C have a probability of 0.3, 0.2, and 0.1 and the top-p value is 0.5, then the model will select either A or B as the next token (using temperature) and doesn't consider C. The default top-p value is 0.95. Specify a lower value for less random responses and a higher value for more random responses. Acceptable value is [0.0, 1.0], default to 0.95.
+    },
+    "name": "A String", # Output only. Identifier. The resource name of the generator. Format: `projects//locations//generators/`
+    "publishedModel": "A String", # Optional. The published Large Language Model name. * To use the latest model version, specify the model name without version number. Example: `text-bison` * To use a stable model version, specify the version number as well. Example: `text-bison@002`.
+    "summarizationContext": { # Summarization context that customer can configure. # Input of prebuilt Summarization feature.
+      "fewShotExamples": [ # Optional. List of few shot examples.
+        { # Providing examples in the generator (i.e. building a few-shot generator) helps convey the desired format of the LLM response.
+          "conversationContext": { # Context of the conversation, including transcripts. # Optional. Conversation transcripts.
+            "messageEntries": [ # Optional. List of message transcripts in the conversation.
+              { # Represents a message entry of a conversation.
+                "createTime": "A String", # Optional. Create time of the message entry.
+                "languageCode": "A String", # Optional. The language of the text. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.
+                "role": "A String", # Optional. Participant role of the message.
+                "text": "A String", # Optional. Transcript content of the message.
+              },
+            ],
+          },
+          "extraInfo": { # Optional. Key is the placeholder field name in input, value is the value of the placeholder. E.g. instruction contains "@price", and ingested data has <"price", "10">
+            "a_key": "A String",
+          },
+          "output": { # Suggestion generated using a Generator. # Required. Example output of the model.
+            "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion.
+              "response": "A String", # Required. Free form suggestion.
+            },
+            "summarySuggestion": { # Suggested summary of the conversation. # Optional. Suggested summary.
+              "summarySections": [ # Required. All the parts of generated summary.
+                { # A component of the generated summary.
+                  "section": "A String", # Required. Name of the section.
+                  "summary": "A String", # Required. Summary text for the section.
+                },
+              ],
+            },
+            "toolCallInfo": [ # Optional. List of request and response for tool calls executed.
+              { # Request and response for a tool call.
+                "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call.
+                  "action": "A String", # Optional. The name of the tool's action associated with this call.
+                  "createTime": "A String", # Output only. Create time of the tool call.
+                  "inputParameters": { # Optional. The action's input parameters.
+                    "a_key": "", # Properties of the object.
+                  },
+                  "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`.
+                },
+                "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call.
+                  "action": "A String", # Optional. The name of the tool's action associated with this call.
+                  "content": "A String", # Only populated if the response content is utf-8 encoded.
+                  "createTime": "A String", # Output only. Create time of the tool call result.
+                  "error": { # An error produced by the tool call. # The tool call's error.
+                    "message": "A String", # Optional. The error message of the function.
+                  },
+                  "rawContent": "A String", # Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded).
+                  "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`.
+                },
+              },
+            ],
+          },
+          "summarizationSectionList": { # List of summarization sections. # Summarization sections.
+            "summarizationSections": [ # Optional. Summarization sections.
+              { # Represents the section of summarization.
+                "definition": "A String", # Optional. Definition of the section, for example, "what the customer needs help with or has question about."
+                "key": "A String", # Optional. Name of the section, for example, "situation".
+                "type": "A String", # Optional. Type of the summarization section.
+              },
+            ],
+          },
+        },
+      ],
+      "outputLanguageCode": "A String", # Optional. The target language of the generated summary. The language code for conversation will be used if this field is empty. Supported 2.0 and later versions.
+      "summarizationSections": [ # Optional. List of sections. Note it contains both predefined section sand customer defined sections.
+        { # Represents the section of summarization.
+          "definition": "A String", # Optional. Definition of the section, for example, "what the customer needs help with or has question about."
+          "key": "A String", # Optional. Name of the section, for example, "situation".
+          "type": "A String", # Optional. Type of the summarization section.
+        },
+      ],
+      "version": "A String", # Optional. Version of the feature. If not set, default to latest version. Current candidates are ["1.0"].
+    },
+    "tools": [ # Optional. Resource names of the tools that the generator can choose from. Format: `projects//locations//tools/`.
+      "A String",
+    ],
+    "triggerEvent": "A String", # Optional. The trigger event of the generator. It defines when the generator is triggered in a conversation.
+    "updateTime": "A String", # Output only. Update time of this generator.
+  },
+  "name": "A String", # Output only. Identifier. The resource name of the evaluation. Format: `projects//locations//generators// evaluations/`
+  "summarizationMetrics": { # Evaluation metrics for summarization generator. # Output only. Only available when the summarization generator is provided.
+    "conversationDetails": [ # Output only. List of conversation details.
+      { # Aggregated evaluation result on conversation level. This conatins evaluation results of all the metrics and sections.
+        "messageEntries": [ # Output only. Conversation transcript that used for summarization evaluation as a reference.
+          { # Represents a message entry of a conversation.
+            "createTime": "A String", # Optional. Create time of the message entry.
+            "languageCode": "A String", # Optional. The language of the text. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.
+            "role": "A String", # Optional. Participant role of the message.
+            "text": "A String", # Optional. Transcript content of the message.
+          },
+        ],
+        "metricDetails": [ # Output only. List of metric details.
+          { # Aggregated result on metric level. This conatins the evaluation results of all the sections.
+            "metric": "A String", # Output only. Metrics name. e.g. accuracy, adherence, completeness.
+            "score": 3.14, # Output only. Aggregated(average) score on this metric across all sections.
+            "sectionDetails": [ # Output only. List of section details.
+              { # Section level result.
+                "evaluationResults": [ # Output only. List of evaluation result. The list only contains one kind of the evaluation result.
+                  { # Evaluation result that contains one of accuracy, adherence or completeness evaluation result.
+                    "accuracyDecomposition": { # Decomposition details for accuracy. # Only available for accuracy metric.
+                      "accuracyReasoning": "A String", # Output only. The accuracy reasoning of the breakdown point.
+                      "isAccurate": True or False, # Output only. Whether the breakdown point is accurate or not.
+                      "point": "A String", # Output only. The breakdown point of the summary.
+                    },
+                    "adherenceRubric": { # Rubric result of the adherence evaluation. A rubric is ued to determine if the summary adheres to all aspects of the given instructions. # Only available for adherence metric.
+                      "isAddressed": True or False, # Output only. A boolean that indicates whether the rubric question is addressed or not.
+                      "question": "A String", # Output only. The question generated from instruction that used to evaluate summary.
+                      "reasoning": "A String", # Output only. The reasoning of the rubric question is addressed or not.
+                    },
+                    "completenessRubric": { # Rubric details of the completeness evaluation result. # Only available for completeness metric.
+                      "isAddressed": True or False, # Output only. A boolean that indicates whether the rubric question is addressed or not.
+                      "question": "A String", # Output only. The question generated from instruction that used to evaluate summary.
+                    },
+                  },
+                ],
+                "score": 3.14, # Output only. Aggregated(average) score on this section across all evaluation results. Either decompositions or rubrics.
+                "section": "A String", # Output only. The name of the summary instruction.
+                "sectionSummary": "A String", # Output only. Summary for this section
+              },
+            ],
+          },
+        ],
+        "sectionTokens": [ # Output only. Conversation level token count per section. This is an aggregated(sum) result of input token of summary acorss all metrics for a single conversation.
+          { # A pair of section name and input token count of the input summary section.
+            "section": "A String", # Output only. The name of the summary instruction.
+            "tokenCount": "A String", # Output only. Token count.
+          },
+        ],
+        "summarySections": [ # Output only. Summary sections that used for summarization evaluation as a reference.
+          { # A component of the generated summary.
+            "section": "A String", # Required. Name of the section.
+            "summary": "A String", # Required. Summary text for the section.
+          },
+        ],
+      },
+    ],
+    "overallMetrics": [ # Output only. A list of aggregated(average) scores per metric section.
+      { # Overall performance per metric. This is the aggregated score for each metric across all conversations that are selected for summarization evaluation.
+        "metric": "A String", # Output only. Metric name. e.g. accuracy, adherence, completeness.
+      },
+    ],
+    "overallSectionTokens": [ # Output only. Overall token per section. This is an aggregated(sum) result of input token of summary acorss all conversations that are selected for summarization evaluation.
+      { # A pair of section name and input token count of the input summary section.
+        "section": "A String", # Output only. The name of the summary instruction.
+        "tokenCount": "A String", # Output only. Token count.
+      },
+    ],
+    "summarizationEvaluationMergedResultsUri": "A String", # Output only. User bucket uri for merged evaluation score and aggregation score csv.
+    "summarizationEvaluationResults": [ # Output only. A list of evaluation results per conversation(&summary), metric and section.
+      { # Evaluation result per conversation(&summary), metric and section.
+        "decompositions": [ # Output only. List of decompostion details
+          { # Decomposition details
+            "accuracyDecomposition": { # Decomposition details for accuracy. # only available for accuracy metric.
+              "accuracyReasoning": "A String", # Output only. The accuracy reasoning of the breakdown point.
+              "isAccurate": True or False, # Output only. Whether the breakdown point is accurate or not.
+              "point": "A String", # Output only. The breakdown point of the summary.
+            },
+            "adherenceDecomposition": { # Decomposition details for adherence. # only available for adherence metric.
+              "adherenceReasoning": "A String", # Output only. The adherence reasoning of the breakdown point.
+              "isAdherent": True or False, # Output only. Whether the breakdown point is adherent or not.
+              "point": "A String", # Output only. The breakdown point of the given instructions.
+            },
+          },
+        ],
+        "evaluationResults": [ # Output only. List of evaluation results.
+          { # Evaluation result that contains one of accuracy, adherence or completeness evaluation result.
+            "accuracyDecomposition": { # Decomposition details for accuracy. # Only available for accuracy metric.
+              "accuracyReasoning": "A String", # Output only. The accuracy reasoning of the breakdown point.
+              "isAccurate": True or False, # Output only. Whether the breakdown point is accurate or not.
+              "point": "A String", # Output only. The breakdown point of the summary.
+            },
+            "adherenceRubric": { # Rubric result of the adherence evaluation. A rubric is ued to determine if the summary adheres to all aspects of the given instructions. # Only available for adherence metric.
+              "isAddressed": True or False, # Output only. A boolean that indicates whether the rubric question is addressed or not.
+              "question": "A String", # Output only. The question generated from instruction that used to evaluate summary.
+              "reasoning": "A String", # Output only. The reasoning of the rubric question is addressed or not.
+            },
+            "completenessRubric": { # Rubric details of the completeness evaluation result. # Only available for completeness metric.
+              "isAddressed": True or False, # Output only. A boolean that indicates whether the rubric question is addressed or not.
+              "question": "A String", # Output only. The question generated from instruction that used to evaluate summary.
+            },
+          },
+        ],
+        "metric": "A String", # Output only. metric name, e.g. accuracy, completeness, adherence, etc.
+        "score": 3.14, # Output only. score calculated from decompositions
+        "section": "A String", # Output only. section/task name, e.g. action, situation, etc
+        "sectionSummary": "A String", # Output only. Summary of this section
+        "sessionId": "A String", # Output only. conversation session id
+      },
+    ],
+  },
+}
+
+  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 an evaluation of generator.
+
+Args:
+  name: string, Required. The generator evaluation resource name. Format: `projects//locations//generators// evaluations/` (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 evaluation of generator.
+
+Args:
+  name: string, Required. The generator evaluation resource name. Format: `projects//locations//generators//evaluations/` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents evaluation result of a generator.
+  "completeTime": "A String", # Output only. Completion time of this generator evaluation.
+  "createTime": "A String", # Output only. Creation time of this generator evaluation.
+  "displayName": "A String", # Optional. The display name of the generator evaluation. At most 64 bytes long.
+  "evaluationStatus": { # A common evalaution pipeline status. # Output only. The result status of the evaluation pipeline. Provides the status information including if the evaluation is still in progress, completed or failed with certain error and user actionable message.
+    "done": True or False, # Output only. If the value is `false`, it means the evaluation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+    "pipelineStatus": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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 result of the evaluation in case of failure in evaluation pipeline.
+      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+      "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+        {
+          "a_key": "", # Properties of the object. Contains field @type with type URL.
+        },
+      ],
+      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+    },
+  },
+  "generatorEvaluationConfig": { # Generator evaluation input config. # Required. The configuration of the evaluation task.
+    "inputDataConfig": { # Input data config details # Required. The config/source of input data.
+      "agentAssistInputDataConfig": { # The distinctive configs for Agent Assist conversations as the conversation source. # The distinctive configs for Agent Assist conversations as the conversation source.
+        "endTime": "A String", # Required. The end of the time range for conversations to be evaluated. Only conversations ended at or before this timestamp will be sampled.
+        "startTime": "A String", # Required. The start of the time range for conversations to be evaluated. Only conversations created at or after this timestamp will be sampled.
+      },
+      "datasetInputDataConfig": { # The distinctive configs for dataset as the conversation source. # The distinctive configs for dataset as the conversation source.
+        "dataset": "A String", # Required. The identifier of the dataset to be evaluated. Format: `projects//locations//datasets/`.
+      },
+      "endTime": "A String", # Optional. The end timestamp to fetch conversation data.
+      "inputDataSourceType": "A String", # Required. The source type of input data.
+      "isSummaryGenerationAllowed": True or False, # Optional. Whether the summary generation is allowed when the pre-existing qualified summaries are insufficient to cover the sample size.
+      "sampleSize": 42, # Optional. Desired number of conversation-summary pairs to be evaluated.
+      "startTime": "A String", # Optional. The start timestamp to fetch conversation data.
+      "summaryGenerationOption": "A String", # Optional. Option to control whether summaries are generated during evaluation.
+    },
+    "outputGcsBucketPath": "A String", # Required. The output Cloud Storage bucket path to store eval files, e.g. per_summary_accuracy_score report. This path is provided by customer and files stored in it are visible to customer, no internal data should be stored in this path.
+    "summarizationConfig": { # Evaluation configs for summarization generator. # Evaluation configs for summarization generator.
+      "accuracyEvaluationVersion": "A String", # Optional. Version for summarization accuracy. This will determine the prompt and model used at backend.
+      "completenessEvaluationVersion": "A String", # Optional. Version for summarization completeness. This will determine the prompt and model used at backend.
+      "enableAccuracyEvaluation": True or False, # Optional. Enable accuracy evaluation.
+      "enableCompletenessEvaluation": True or False, # Optional. Enable completeness evaluation.
+      "evaluatorVersion": "A String", # Output only. Version for summarization evaluation.
+    },
+  },
+  "initialGenerator": { # LLM generator. # Required. The initial generator that was used when creating this evaluation. This is a copy of the generator read from storage when creating the evaluation.
+    "createTime": "A String", # Output only. Creation time of this generator.
+    "description": "A String", # Optional. Human readable description of the generator.
+    "freeFormContext": { # Free form generator context that customer can configure. # Input of free from generator to LLM.
+      "text": "A String", # Optional. Free form text input to LLM.
+    },
+    "inferenceParameter": { # The parameters of inference. # Optional. Inference parameters for this generator.
+      "maxOutputTokens": 42, # Optional. Maximum number of the output tokens for the generator.
+      "temperature": 3.14, # Optional. Controls the randomness of LLM predictions. Low temperature = less random. High temperature = more random. If unset (or 0), uses a default value of 0.
+      "topK": 42, # Optional. Top-k changes how the model selects tokens for output. A top-k of 1 means the selected token is the most probable among all tokens in the model's vocabulary (also called greedy decoding), while a top-k of 3 means that the next token is selected from among the 3 most probable tokens (using temperature). For each token selection step, the top K tokens with the highest probabilities are sampled. Then tokens are further filtered based on topP with the final token selected using temperature sampling. Specify a lower value for less random responses and a higher value for more random responses. Acceptable value is [1, 40], default to 40.
+      "topP": 3.14, # Optional. Top-p changes how the model selects tokens for output. Tokens are selected from most K (see topK parameter) probable to least until the sum of their probabilities equals the top-p value. For example, if tokens A, B, and C have a probability of 0.3, 0.2, and 0.1 and the top-p value is 0.5, then the model will select either A or B as the next token (using temperature) and doesn't consider C. The default top-p value is 0.95. Specify a lower value for less random responses and a higher value for more random responses. Acceptable value is [0.0, 1.0], default to 0.95.
+    },
+    "name": "A String", # Output only. Identifier. The resource name of the generator. Format: `projects//locations//generators/`
+    "publishedModel": "A String", # Optional. The published Large Language Model name. * To use the latest model version, specify the model name without version number. Example: `text-bison` * To use a stable model version, specify the version number as well. Example: `text-bison@002`.
+    "summarizationContext": { # Summarization context that customer can configure. # Input of prebuilt Summarization feature.
+      "fewShotExamples": [ # Optional. List of few shot examples.
+        { # Providing examples in the generator (i.e. building a few-shot generator) helps convey the desired format of the LLM response.
+          "conversationContext": { # Context of the conversation, including transcripts. # Optional. Conversation transcripts.
+            "messageEntries": [ # Optional. List of message transcripts in the conversation.
+              { # Represents a message entry of a conversation.
+                "createTime": "A String", # Optional. Create time of the message entry.
+                "languageCode": "A String", # Optional. The language of the text. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.
+                "role": "A String", # Optional. Participant role of the message.
+                "text": "A String", # Optional. Transcript content of the message.
+              },
+            ],
+          },
+          "extraInfo": { # Optional. Key is the placeholder field name in input, value is the value of the placeholder. E.g. instruction contains "@price", and ingested data has <"price", "10">
+            "a_key": "A String",
+          },
+          "output": { # Suggestion generated using a Generator. # Required. Example output of the model.
+            "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion.
+              "response": "A String", # Required. Free form suggestion.
+            },
+            "summarySuggestion": { # Suggested summary of the conversation. # Optional. Suggested summary.
+              "summarySections": [ # Required. All the parts of generated summary.
+                { # A component of the generated summary.
+                  "section": "A String", # Required. Name of the section.
+                  "summary": "A String", # Required. Summary text for the section.
+                },
+              ],
+            },
+            "toolCallInfo": [ # Optional. List of request and response for tool calls executed.
+              { # Request and response for a tool call.
+                "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call.
+                  "action": "A String", # Optional. The name of the tool's action associated with this call.
+                  "createTime": "A String", # Output only. Create time of the tool call.
+                  "inputParameters": { # Optional. The action's input parameters.
+                    "a_key": "", # Properties of the object.
+                  },
+                  "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`.
+                },
+                "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call.
+                  "action": "A String", # Optional. The name of the tool's action associated with this call.
+                  "content": "A String", # Only populated if the response content is utf-8 encoded.
+                  "createTime": "A String", # Output only. Create time of the tool call result.
+                  "error": { # An error produced by the tool call. # The tool call's error.
+                    "message": "A String", # Optional. The error message of the function.
+                  },
+                  "rawContent": "A String", # Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded).
+                  "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`.
+                },
+              },
+            ],
+          },
+          "summarizationSectionList": { # List of summarization sections. # Summarization sections.
+            "summarizationSections": [ # Optional. Summarization sections.
+              { # Represents the section of summarization.
+                "definition": "A String", # Optional. Definition of the section, for example, "what the customer needs help with or has question about."
+                "key": "A String", # Optional. Name of the section, for example, "situation".
+                "type": "A String", # Optional. Type of the summarization section.
+              },
+            ],
+          },
+        },
+      ],
+      "outputLanguageCode": "A String", # Optional. The target language of the generated summary. The language code for conversation will be used if this field is empty. Supported 2.0 and later versions.
+      "summarizationSections": [ # Optional. List of sections. Note it contains both predefined section sand customer defined sections.
+        { # Represents the section of summarization.
+          "definition": "A String", # Optional. Definition of the section, for example, "what the customer needs help with or has question about."
+          "key": "A String", # Optional. Name of the section, for example, "situation".
+          "type": "A String", # Optional. Type of the summarization section.
+        },
+      ],
+      "version": "A String", # Optional. Version of the feature. If not set, default to latest version. Current candidates are ["1.0"].
+    },
+    "tools": [ # Optional. Resource names of the tools that the generator can choose from. Format: `projects//locations//tools/`.
+      "A String",
+    ],
+    "triggerEvent": "A String", # Optional. The trigger event of the generator. It defines when the generator is triggered in a conversation.
+    "updateTime": "A String", # Output only. Update time of this generator.
+  },
+  "name": "A String", # Output only. Identifier. The resource name of the evaluation. Format: `projects//locations//generators// evaluations/`
+  "summarizationMetrics": { # Evaluation metrics for summarization generator. # Output only. Only available when the summarization generator is provided.
+    "conversationDetails": [ # Output only. List of conversation details.
+      { # Aggregated evaluation result on conversation level. This conatins evaluation results of all the metrics and sections.
+        "messageEntries": [ # Output only. Conversation transcript that used for summarization evaluation as a reference.
+          { # Represents a message entry of a conversation.
+            "createTime": "A String", # Optional. Create time of the message entry.
+            "languageCode": "A String", # Optional. The language of the text. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.
+            "role": "A String", # Optional. Participant role of the message.
+            "text": "A String", # Optional. Transcript content of the message.
+          },
+        ],
+        "metricDetails": [ # Output only. List of metric details.
+          { # Aggregated result on metric level. This conatins the evaluation results of all the sections.
+            "metric": "A String", # Output only. Metrics name. e.g. accuracy, adherence, completeness.
+            "score": 3.14, # Output only. Aggregated(average) score on this metric across all sections.
+            "sectionDetails": [ # Output only. List of section details.
+              { # Section level result.
+                "evaluationResults": [ # Output only. List of evaluation result. The list only contains one kind of the evaluation result.
+                  { # Evaluation result that contains one of accuracy, adherence or completeness evaluation result.
+                    "accuracyDecomposition": { # Decomposition details for accuracy. # Only available for accuracy metric.
+                      "accuracyReasoning": "A String", # Output only. The accuracy reasoning of the breakdown point.
+                      "isAccurate": True or False, # Output only. Whether the breakdown point is accurate or not.
+                      "point": "A String", # Output only. The breakdown point of the summary.
+                    },
+                    "adherenceRubric": { # Rubric result of the adherence evaluation. A rubric is ued to determine if the summary adheres to all aspects of the given instructions. # Only available for adherence metric.
+                      "isAddressed": True or False, # Output only. A boolean that indicates whether the rubric question is addressed or not.
+                      "question": "A String", # Output only. The question generated from instruction that used to evaluate summary.
+                      "reasoning": "A String", # Output only. The reasoning of the rubric question is addressed or not.
+                    },
+                    "completenessRubric": { # Rubric details of the completeness evaluation result. # Only available for completeness metric.
+                      "isAddressed": True or False, # Output only. A boolean that indicates whether the rubric question is addressed or not.
+                      "question": "A String", # Output only. The question generated from instruction that used to evaluate summary.
+                    },
+                  },
+                ],
+                "score": 3.14, # Output only. Aggregated(average) score on this section across all evaluation results. Either decompositions or rubrics.
+                "section": "A String", # Output only. The name of the summary instruction.
+                "sectionSummary": "A String", # Output only. Summary for this section
+              },
+            ],
+          },
+        ],
+        "sectionTokens": [ # Output only. Conversation level token count per section. This is an aggregated(sum) result of input token of summary acorss all metrics for a single conversation.
+          { # A pair of section name and input token count of the input summary section.
+            "section": "A String", # Output only. The name of the summary instruction.
+            "tokenCount": "A String", # Output only. Token count.
+          },
+        ],
+        "summarySections": [ # Output only. Summary sections that used for summarization evaluation as a reference.
+          { # A component of the generated summary.
+            "section": "A String", # Required. Name of the section.
+            "summary": "A String", # Required. Summary text for the section.
+          },
+        ],
+      },
+    ],
+    "overallMetrics": [ # Output only. A list of aggregated(average) scores per metric section.
+      { # Overall performance per metric. This is the aggregated score for each metric across all conversations that are selected for summarization evaluation.
+        "metric": "A String", # Output only. Metric name. e.g. accuracy, adherence, completeness.
+      },
+    ],
+    "overallSectionTokens": [ # Output only. Overall token per section. This is an aggregated(sum) result of input token of summary acorss all conversations that are selected for summarization evaluation.
+      { # A pair of section name and input token count of the input summary section.
+        "section": "A String", # Output only. The name of the summary instruction.
+        "tokenCount": "A String", # Output only. Token count.
+      },
+    ],
+    "summarizationEvaluationMergedResultsUri": "A String", # Output only. User bucket uri for merged evaluation score and aggregation score csv.
+    "summarizationEvaluationResults": [ # Output only. A list of evaluation results per conversation(&summary), metric and section.
+      { # Evaluation result per conversation(&summary), metric and section.
+        "decompositions": [ # Output only. List of decompostion details
+          { # Decomposition details
+            "accuracyDecomposition": { # Decomposition details for accuracy. # only available for accuracy metric.
+              "accuracyReasoning": "A String", # Output only. The accuracy reasoning of the breakdown point.
+              "isAccurate": True or False, # Output only. Whether the breakdown point is accurate or not.
+              "point": "A String", # Output only. The breakdown point of the summary.
+            },
+            "adherenceDecomposition": { # Decomposition details for adherence. # only available for adherence metric.
+              "adherenceReasoning": "A String", # Output only. The adherence reasoning of the breakdown point.
+              "isAdherent": True or False, # Output only. Whether the breakdown point is adherent or not.
+              "point": "A String", # Output only. The breakdown point of the given instructions.
+            },
+          },
+        ],
+        "evaluationResults": [ # Output only. List of evaluation results.
+          { # Evaluation result that contains one of accuracy, adherence or completeness evaluation result.
+            "accuracyDecomposition": { # Decomposition details for accuracy. # Only available for accuracy metric.
+              "accuracyReasoning": "A String", # Output only. The accuracy reasoning of the breakdown point.
+              "isAccurate": True or False, # Output only. Whether the breakdown point is accurate or not.
+              "point": "A String", # Output only. The breakdown point of the summary.
+            },
+            "adherenceRubric": { # Rubric result of the adherence evaluation. A rubric is ued to determine if the summary adheres to all aspects of the given instructions. # Only available for adherence metric.
+              "isAddressed": True or False, # Output only. A boolean that indicates whether the rubric question is addressed or not.
+              "question": "A String", # Output only. The question generated from instruction that used to evaluate summary.
+              "reasoning": "A String", # Output only. The reasoning of the rubric question is addressed or not.
+            },
+            "completenessRubric": { # Rubric details of the completeness evaluation result. # Only available for completeness metric.
+              "isAddressed": True or False, # Output only. A boolean that indicates whether the rubric question is addressed or not.
+              "question": "A String", # Output only. The question generated from instruction that used to evaluate summary.
+            },
+          },
+        ],
+        "metric": "A String", # Output only. metric name, e.g. accuracy, completeness, adherence, etc.
+        "score": 3.14, # Output only. score calculated from decompositions
+        "section": "A String", # Output only. section/task name, e.g. action, situation, etc
+        "sectionSummary": "A String", # Output only. Summary of this section
+        "sessionId": "A String", # Output only. conversation session id
+      },
+    ],
+  },
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) + 
Lists evaluations of generator.
+
+Args:
+  parent: string, Required. The generator resource name. Format: `projects//locations//generators/` Wildcard value `-` is supported on generator_id to list evaluations across all generators under same project. (required)
+  pageSize: integer, Optional. Maximum number of evaluations to return in a single page. By default 100 and at most 1000.
+  pageToken: string, Optional. The next_page_token value returned from a previous list request.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response of ListGeneratorEvaluations.
+  "generatorEvaluations": [ # The list of evaluations to return.
+    { # Represents evaluation result of a generator.
+      "completeTime": "A String", # Output only. Completion time of this generator evaluation.
+      "createTime": "A String", # Output only. Creation time of this generator evaluation.
+      "displayName": "A String", # Optional. The display name of the generator evaluation. At most 64 bytes long.
+      "evaluationStatus": { # A common evalaution pipeline status. # Output only. The result status of the evaluation pipeline. Provides the status information including if the evaluation is still in progress, completed or failed with certain error and user actionable message.
+        "done": True or False, # Output only. If the value is `false`, it means the evaluation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+        "pipelineStatus": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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 result of the evaluation in case of failure in evaluation pipeline.
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+        },
+      },
+      "generatorEvaluationConfig": { # Generator evaluation input config. # Required. The configuration of the evaluation task.
+        "inputDataConfig": { # Input data config details # Required. The config/source of input data.
+          "agentAssistInputDataConfig": { # The distinctive configs for Agent Assist conversations as the conversation source. # The distinctive configs for Agent Assist conversations as the conversation source.
+            "endTime": "A String", # Required. The end of the time range for conversations to be evaluated. Only conversations ended at or before this timestamp will be sampled.
+            "startTime": "A String", # Required. The start of the time range for conversations to be evaluated. Only conversations created at or after this timestamp will be sampled.
+          },
+          "datasetInputDataConfig": { # The distinctive configs for dataset as the conversation source. # The distinctive configs for dataset as the conversation source.
+            "dataset": "A String", # Required. The identifier of the dataset to be evaluated. Format: `projects//locations//datasets/`.
+          },
+          "endTime": "A String", # Optional. The end timestamp to fetch conversation data.
+          "inputDataSourceType": "A String", # Required. The source type of input data.
+          "isSummaryGenerationAllowed": True or False, # Optional. Whether the summary generation is allowed when the pre-existing qualified summaries are insufficient to cover the sample size.
+          "sampleSize": 42, # Optional. Desired number of conversation-summary pairs to be evaluated.
+          "startTime": "A String", # Optional. The start timestamp to fetch conversation data.
+          "summaryGenerationOption": "A String", # Optional. Option to control whether summaries are generated during evaluation.
+        },
+        "outputGcsBucketPath": "A String", # Required. The output Cloud Storage bucket path to store eval files, e.g. per_summary_accuracy_score report. This path is provided by customer and files stored in it are visible to customer, no internal data should be stored in this path.
+        "summarizationConfig": { # Evaluation configs for summarization generator. # Evaluation configs for summarization generator.
+          "accuracyEvaluationVersion": "A String", # Optional. Version for summarization accuracy. This will determine the prompt and model used at backend.
+          "completenessEvaluationVersion": "A String", # Optional. Version for summarization completeness. This will determine the prompt and model used at backend.
+          "enableAccuracyEvaluation": True or False, # Optional. Enable accuracy evaluation.
+          "enableCompletenessEvaluation": True or False, # Optional. Enable completeness evaluation.
+          "evaluatorVersion": "A String", # Output only. Version for summarization evaluation.
+        },
+      },
+      "initialGenerator": { # LLM generator. # Required. The initial generator that was used when creating this evaluation. This is a copy of the generator read from storage when creating the evaluation.
+        "createTime": "A String", # Output only. Creation time of this generator.
+        "description": "A String", # Optional. Human readable description of the generator.
+        "freeFormContext": { # Free form generator context that customer can configure. # Input of free from generator to LLM.
+          "text": "A String", # Optional. Free form text input to LLM.
+        },
+        "inferenceParameter": { # The parameters of inference. # Optional. Inference parameters for this generator.
+          "maxOutputTokens": 42, # Optional. Maximum number of the output tokens for the generator.
+          "temperature": 3.14, # Optional. Controls the randomness of LLM predictions. Low temperature = less random. High temperature = more random. If unset (or 0), uses a default value of 0.
+          "topK": 42, # Optional. Top-k changes how the model selects tokens for output. A top-k of 1 means the selected token is the most probable among all tokens in the model's vocabulary (also called greedy decoding), while a top-k of 3 means that the next token is selected from among the 3 most probable tokens (using temperature). For each token selection step, the top K tokens with the highest probabilities are sampled. Then tokens are further filtered based on topP with the final token selected using temperature sampling. Specify a lower value for less random responses and a higher value for more random responses. Acceptable value is [1, 40], default to 40.
+          "topP": 3.14, # Optional. Top-p changes how the model selects tokens for output. Tokens are selected from most K (see topK parameter) probable to least until the sum of their probabilities equals the top-p value. For example, if tokens A, B, and C have a probability of 0.3, 0.2, and 0.1 and the top-p value is 0.5, then the model will select either A or B as the next token (using temperature) and doesn't consider C. The default top-p value is 0.95. Specify a lower value for less random responses and a higher value for more random responses. Acceptable value is [0.0, 1.0], default to 0.95.
+        },
+        "name": "A String", # Output only. Identifier. The resource name of the generator. Format: `projects//locations//generators/`
+        "publishedModel": "A String", # Optional. The published Large Language Model name. * To use the latest model version, specify the model name without version number. Example: `text-bison` * To use a stable model version, specify the version number as well. Example: `text-bison@002`.
+        "summarizationContext": { # Summarization context that customer can configure. # Input of prebuilt Summarization feature.
+          "fewShotExamples": [ # Optional. List of few shot examples.
+            { # Providing examples in the generator (i.e. building a few-shot generator) helps convey the desired format of the LLM response.
+              "conversationContext": { # Context of the conversation, including transcripts. # Optional. Conversation transcripts.
+                "messageEntries": [ # Optional. List of message transcripts in the conversation.
+                  { # Represents a message entry of a conversation.
+                    "createTime": "A String", # Optional. Create time of the message entry.
+                    "languageCode": "A String", # Optional. The language of the text. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.
+                    "role": "A String", # Optional. Participant role of the message.
+                    "text": "A String", # Optional. Transcript content of the message.
+                  },
+                ],
+              },
+              "extraInfo": { # Optional. Key is the placeholder field name in input, value is the value of the placeholder. E.g. instruction contains "@price", and ingested data has <"price", "10">
+                "a_key": "A String",
+              },
+              "output": { # Suggestion generated using a Generator. # Required. Example output of the model.
+                "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion.
+                  "response": "A String", # Required. Free form suggestion.
+                },
+                "summarySuggestion": { # Suggested summary of the conversation. # Optional. Suggested summary.
+                  "summarySections": [ # Required. All the parts of generated summary.
+                    { # A component of the generated summary.
+                      "section": "A String", # Required. Name of the section.
+                      "summary": "A String", # Required. Summary text for the section.
+                    },
+                  ],
+                },
+                "toolCallInfo": [ # Optional. List of request and response for tool calls executed.
+                  { # Request and response for a tool call.
+                    "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call.
+                      "action": "A String", # Optional. The name of the tool's action associated with this call.
+                      "createTime": "A String", # Output only. Create time of the tool call.
+                      "inputParameters": { # Optional. The action's input parameters.
+                        "a_key": "", # Properties of the object.
+                      },
+                      "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`.
+                    },
+                    "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call.
+                      "action": "A String", # Optional. The name of the tool's action associated with this call.
+                      "content": "A String", # Only populated if the response content is utf-8 encoded.
+                      "createTime": "A String", # Output only. Create time of the tool call result.
+                      "error": { # An error produced by the tool call. # The tool call's error.
+                        "message": "A String", # Optional. The error message of the function.
+                      },
+                      "rawContent": "A String", # Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded).
+                      "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`.
+                    },
+                  },
+                ],
+              },
+              "summarizationSectionList": { # List of summarization sections. # Summarization sections.
+                "summarizationSections": [ # Optional. Summarization sections.
+                  { # Represents the section of summarization.
+                    "definition": "A String", # Optional. Definition of the section, for example, "what the customer needs help with or has question about."
+                    "key": "A String", # Optional. Name of the section, for example, "situation".
+                    "type": "A String", # Optional. Type of the summarization section.
+                  },
+                ],
+              },
+            },
+          ],
+          "outputLanguageCode": "A String", # Optional. The target language of the generated summary. The language code for conversation will be used if this field is empty. Supported 2.0 and later versions.
+          "summarizationSections": [ # Optional. List of sections. Note it contains both predefined section sand customer defined sections.
+            { # Represents the section of summarization.
+              "definition": "A String", # Optional. Definition of the section, for example, "what the customer needs help with or has question about."
+              "key": "A String", # Optional. Name of the section, for example, "situation".
+              "type": "A String", # Optional. Type of the summarization section.
+            },
+          ],
+          "version": "A String", # Optional. Version of the feature. If not set, default to latest version. Current candidates are ["1.0"].
+        },
+        "tools": [ # Optional. Resource names of the tools that the generator can choose from. Format: `projects//locations//tools/`.
+          "A String",
+        ],
+        "triggerEvent": "A String", # Optional. The trigger event of the generator. It defines when the generator is triggered in a conversation.
+        "updateTime": "A String", # Output only. Update time of this generator.
+      },
+      "name": "A String", # Output only. Identifier. The resource name of the evaluation. Format: `projects//locations//generators// evaluations/`
+      "summarizationMetrics": { # Evaluation metrics for summarization generator. # Output only. Only available when the summarization generator is provided.
+        "conversationDetails": [ # Output only. List of conversation details.
+          { # Aggregated evaluation result on conversation level. This conatins evaluation results of all the metrics and sections.
+            "messageEntries": [ # Output only. Conversation transcript that used for summarization evaluation as a reference.
+              { # Represents a message entry of a conversation.
+                "createTime": "A String", # Optional. Create time of the message entry.
+                "languageCode": "A String", # Optional. The language of the text. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.
+                "role": "A String", # Optional. Participant role of the message.
+                "text": "A String", # Optional. Transcript content of the message.
+              },
+            ],
+            "metricDetails": [ # Output only. List of metric details.
+              { # Aggregated result on metric level. This conatins the evaluation results of all the sections.
+                "metric": "A String", # Output only. Metrics name. e.g. accuracy, adherence, completeness.
+                "score": 3.14, # Output only. Aggregated(average) score on this metric across all sections.
+                "sectionDetails": [ # Output only. List of section details.
+                  { # Section level result.
+                    "evaluationResults": [ # Output only. List of evaluation result. The list only contains one kind of the evaluation result.
+                      { # Evaluation result that contains one of accuracy, adherence or completeness evaluation result.
+                        "accuracyDecomposition": { # Decomposition details for accuracy. # Only available for accuracy metric.
+                          "accuracyReasoning": "A String", # Output only. The accuracy reasoning of the breakdown point.
+                          "isAccurate": True or False, # Output only. Whether the breakdown point is accurate or not.
+                          "point": "A String", # Output only. The breakdown point of the summary.
+                        },
+                        "adherenceRubric": { # Rubric result of the adherence evaluation. A rubric is ued to determine if the summary adheres to all aspects of the given instructions. # Only available for adherence metric.
+                          "isAddressed": True or False, # Output only. A boolean that indicates whether the rubric question is addressed or not.
+                          "question": "A String", # Output only. The question generated from instruction that used to evaluate summary.
+                          "reasoning": "A String", # Output only. The reasoning of the rubric question is addressed or not.
+                        },
+                        "completenessRubric": { # Rubric details of the completeness evaluation result. # Only available for completeness metric.
+                          "isAddressed": True or False, # Output only. A boolean that indicates whether the rubric question is addressed or not.
+                          "question": "A String", # Output only. The question generated from instruction that used to evaluate summary.
+                        },
+                      },
+                    ],
+                    "score": 3.14, # Output only. Aggregated(average) score on this section across all evaluation results. Either decompositions or rubrics.
+                    "section": "A String", # Output only. The name of the summary instruction.
+                    "sectionSummary": "A String", # Output only. Summary for this section
+                  },
+                ],
+              },
+            ],
+            "sectionTokens": [ # Output only. Conversation level token count per section. This is an aggregated(sum) result of input token of summary acorss all metrics for a single conversation.
+              { # A pair of section name and input token count of the input summary section.
+                "section": "A String", # Output only. The name of the summary instruction.
+                "tokenCount": "A String", # Output only. Token count.
+              },
+            ],
+            "summarySections": [ # Output only. Summary sections that used for summarization evaluation as a reference.
+              { # A component of the generated summary.
+                "section": "A String", # Required. Name of the section.
+                "summary": "A String", # Required. Summary text for the section.
+              },
+            ],
+          },
+        ],
+        "overallMetrics": [ # Output only. A list of aggregated(average) scores per metric section.
+          { # Overall performance per metric. This is the aggregated score for each metric across all conversations that are selected for summarization evaluation.
+            "metric": "A String", # Output only. Metric name. e.g. accuracy, adherence, completeness.
+          },
+        ],
+        "overallSectionTokens": [ # Output only. Overall token per section. This is an aggregated(sum) result of input token of summary acorss all conversations that are selected for summarization evaluation.
+          { # A pair of section name and input token count of the input summary section.
+            "section": "A String", # Output only. The name of the summary instruction.
+            "tokenCount": "A String", # Output only. Token count.
+          },
+        ],
+        "summarizationEvaluationMergedResultsUri": "A String", # Output only. User bucket uri for merged evaluation score and aggregation score csv.
+        "summarizationEvaluationResults": [ # Output only. A list of evaluation results per conversation(&summary), metric and section.
+          { # Evaluation result per conversation(&summary), metric and section.
+            "decompositions": [ # Output only. List of decompostion details
+              { # Decomposition details
+                "accuracyDecomposition": { # Decomposition details for accuracy. # only available for accuracy metric.
+                  "accuracyReasoning": "A String", # Output only. The accuracy reasoning of the breakdown point.
+                  "isAccurate": True or False, # Output only. Whether the breakdown point is accurate or not.
+                  "point": "A String", # Output only. The breakdown point of the summary.
+                },
+                "adherenceDecomposition": { # Decomposition details for adherence. # only available for adherence metric.
+                  "adherenceReasoning": "A String", # Output only. The adherence reasoning of the breakdown point.
+                  "isAdherent": True or False, # Output only. Whether the breakdown point is adherent or not.
+                  "point": "A String", # Output only. The breakdown point of the given instructions.
+                },
+              },
+            ],
+            "evaluationResults": [ # Output only. List of evaluation results.
+              { # Evaluation result that contains one of accuracy, adherence or completeness evaluation result.
+                "accuracyDecomposition": { # Decomposition details for accuracy. # Only available for accuracy metric.
+                  "accuracyReasoning": "A String", # Output only. The accuracy reasoning of the breakdown point.
+                  "isAccurate": True or False, # Output only. Whether the breakdown point is accurate or not.
+                  "point": "A String", # Output only. The breakdown point of the summary.
+                },
+                "adherenceRubric": { # Rubric result of the adherence evaluation. A rubric is ued to determine if the summary adheres to all aspects of the given instructions. # Only available for adherence metric.
+                  "isAddressed": True or False, # Output only. A boolean that indicates whether the rubric question is addressed or not.
+                  "question": "A String", # Output only. The question generated from instruction that used to evaluate summary.
+                  "reasoning": "A String", # Output only. The reasoning of the rubric question is addressed or not.
+                },
+                "completenessRubric": { # Rubric details of the completeness evaluation result. # Only available for completeness metric.
+                  "isAddressed": True or False, # Output only. A boolean that indicates whether the rubric question is addressed or not.
+                  "question": "A String", # Output only. The question generated from instruction that used to evaluate summary.
+                },
+              },
+            ],
+            "metric": "A String", # Output only. metric name, e.g. accuracy, completeness, adherence, etc.
+            "score": 3.14, # Output only. score calculated from decompositions
+            "section": "A String", # Output only. section/task name, e.g. action, situation, etc
+            "sectionSummary": "A String", # Output only. Summary of this section
+            "sessionId": "A String", # Output only. conversation session id
+          },
+        ],
+      },
+    },
+  ],
+  "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
+}
+
+ +
+ 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/dialogflow_v2.projects.locations.generators.html b/docs/dyn/dialogflow_v2.projects.locations.generators.html index 6b150c61feb..0c7a870af32 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.generators.html +++ b/docs/dyn/dialogflow_v2.projects.locations.generators.html @@ -74,6 +74,11 @@

Dialogflow API . projects . locations . generators

Instance Methods

+

+ evaluations() +

+

Returns the evaluations Resource.

+

close()

Close httplib2 connections.

diff --git a/docs/dyn/dialogflow_v2.projects.locations.html b/docs/dyn/dialogflow_v2.projects.locations.html index 51005c158c0..7a3f679253d 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.html +++ b/docs/dyn/dialogflow_v2.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. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (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/dialogflow_v2beta1.projects.locations.generators.evaluations.html b/docs/dyn/dialogflow_v2beta1.projects.locations.generators.evaluations.html new file mode 100644 index 00000000000..d63d10cdb1a --- /dev/null +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.generators.evaluations.html @@ -0,0 +1,946 @@ + + + +

Dialogflow API . projects . locations . generators . evaluations

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, x__xgafv=None)

+

Creates evaluation of a generator.

+

+ delete(name, x__xgafv=None)

+

Deletes an evaluation of generator.

+

+ get(name, x__xgafv=None)

+

Gets an evaluation of generator.

+

+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists evaluations of generator.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) + 
Creates evaluation of a generator.
+
+Args:
+  parent: string, Required. The generator resource name. Format: `projects//locations//generators/` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents evaluation result of a generator.
+  "completeTime": "A String", # Output only. Completion time of this generator evaluation.
+  "createTime": "A String", # Output only. Creation time of this generator evaluation.
+  "displayName": "A String", # Optional. The display name of the generator evaluation. At most 64 bytes long.
+  "evaluationStatus": { # A common evalaution pipeline status. # Output only. The result status of the evaluation pipeline. Provides the status information including if the evaluation is still in progress, completed or failed with certain error and user actionable message.
+    "done": True or False, # Output only. If the value is `false`, it means the evaluation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+    "pipelineStatus": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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 result of the evaluation in case of failure in evaluation pipeline.
+      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+      "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+        {
+          "a_key": "", # Properties of the object. Contains field @type with type URL.
+        },
+      ],
+      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+    },
+  },
+  "generatorEvaluationConfig": { # Generator evaluation input config. # Required. The configuration of the evaluation task.
+    "inputDataConfig": { # Input data config details # Required. The config/source of input data.
+      "agentAssistInputDataConfig": { # The distinctive configs for Agent Assist conversations as the conversation source. # The distinctive configs for Agent Assist conversations as the conversation source.
+        "endTime": "A String", # Required. The end of the time range for conversations to be evaluated. Only conversations ended at or before this timestamp will be sampled.
+        "startTime": "A String", # Required. The start of the time range for conversations to be evaluated. Only conversations created at or after this timestamp will be sampled.
+      },
+      "datasetInputDataConfig": { # The distinctive configs for dataset as the conversation source. # The distinctive configs for dataset as the conversation source.
+        "dataset": "A String", # Required. The identifier of the dataset to be evaluated. Format: `projects//locations//datasets/`.
+      },
+      "endTime": "A String", # Optional. The end timestamp to fetch conversation data.
+      "inputDataSourceType": "A String", # Required. The source type of input data.
+      "isSummaryGenerationAllowed": True or False, # Optional. Whether the summary generation is allowed when the pre-existing qualified summaries are insufficient to cover the sample size.
+      "sampleSize": 42, # Optional. Desired number of conversation-summary pairs to be evaluated.
+      "startTime": "A String", # Optional. The start timestamp to fetch conversation data.
+      "summaryGenerationOption": "A String", # Optional. Option to control whether summaries are generated during evaluation.
+    },
+    "outputGcsBucketPath": "A String", # Required. The output Cloud Storage bucket path to store eval files, e.g. per_summary_accuracy_score report. This path is provided by customer and files stored in it are visible to customer, no internal data should be stored in this path.
+    "summarizationConfig": { # Evaluation configs for summarization generator. # Evaluation configs for summarization generator.
+      "accuracyEvaluationVersion": "A String", # Optional. Version for summarization accuracy. This will determine the prompt and model used at backend.
+      "completenessEvaluationVersion": "A String", # Optional. Version for summarization completeness. This will determine the prompt and model used at backend.
+      "enableAccuracyEvaluation": True or False, # Optional. Enable accuracy evaluation.
+      "enableCompletenessEvaluation": True or False, # Optional. Enable completeness evaluation.
+      "evaluatorVersion": "A String", # Output only. Version for summarization evaluation.
+    },
+  },
+  "initialGenerator": { # LLM generator. # Required. The initial generator that was used when creating this evaluation. This is a copy of the generator read from storage when creating the evaluation.
+    "createTime": "A String", # Output only. Creation time of this generator.
+    "description": "A String", # Optional. Human readable description of the generator.
+    "freeFormContext": { # Free form generator context that customer can configure. # Input of free from generator to LLM.
+      "text": "A String", # Optional. Free form text input to LLM.
+    },
+    "inferenceParameter": { # The parameters of inference. # Optional. Inference parameters for this generator.
+      "maxOutputTokens": 42, # Optional. Maximum number of the output tokens for the generator.
+      "temperature": 3.14, # Optional. Controls the randomness of LLM predictions. Low temperature = less random. High temperature = more random. If unset (or 0), uses a default value of 0.
+      "topK": 42, # Optional. Top-k changes how the model selects tokens for output. A top-k of 1 means the selected token is the most probable among all tokens in the model's vocabulary (also called greedy decoding), while a top-k of 3 means that the next token is selected from among the 3 most probable tokens (using temperature). For each token selection step, the top K tokens with the highest probabilities are sampled. Then tokens are further filtered based on topP with the final token selected using temperature sampling. Specify a lower value for less random responses and a higher value for more random responses. Acceptable value is [1, 40], default to 40.
+      "topP": 3.14, # Optional. Top-p changes how the model selects tokens for output. Tokens are selected from most K (see topK parameter) probable to least until the sum of their probabilities equals the top-p value. For example, if tokens A, B, and C have a probability of 0.3, 0.2, and 0.1 and the top-p value is 0.5, then the model will select either A or B as the next token (using temperature) and doesn't consider C. The default top-p value is 0.95. Specify a lower value for less random responses and a higher value for more random responses. Acceptable value is [0.0, 1.0], default to 0.95.
+    },
+    "name": "A String", # Output only. Identifier. The resource name of the generator. Format: `projects//locations//generators/`
+    "publishedModel": "A String", # Optional. The published Large Language Model name. * To use the latest model version, specify the model name without version number. Example: `text-bison` * To use a stable model version, specify the version number as well. Example: `text-bison@002`.
+    "summarizationContext": { # Summarization context that customer can configure. # Input of Summarization feature.
+      "fewShotExamples": [ # Optional. List of few shot examples.
+        { # Providing examples in the generator (i.e. building a few-shot generator) helps convey the desired format of the LLM response.
+          "conversationContext": { # Context of the conversation, including transcripts. # Optional. Conversation transcripts.
+            "messageEntries": [ # Optional. List of message transcripts in the conversation.
+              { # Represents a message entry of a conversation.
+                "createTime": "A String", # Optional. Create time of the message entry.
+                "languageCode": "A String", # Optional. The language of the text. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.
+                "role": "A String", # Optional. Participant role of the message.
+                "text": "A String", # Optional. Transcript content of the message.
+              },
+            ],
+          },
+          "extraInfo": { # Optional. Key is the placeholder field name in input, value is the value of the placeholder. E.g. instruction contains "@price", and ingested data has <"price", "10">
+            "a_key": "A String",
+          },
+          "output": { # Suggestion generated using a Generator. # Required. Example output of the model.
+            "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion.
+              "response": "A String", # Required. Free form suggestion.
+            },
+            "summarySuggestion": { # Suggested summary of the conversation. # Optional. Suggested summary.
+              "summarySections": [ # Required. All the parts of generated summary.
+                { # A component of the generated summary.
+                  "section": "A String", # Required. Name of the section.
+                  "summary": "A String", # Required. Summary text for the section.
+                },
+              ],
+            },
+            "toolCallInfo": [ # Optional. List of request and response for tool calls executed.
+              { # Request and response for a tool call.
+                "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call.
+                  "action": "A String", # Optional. The name of the tool's action associated with this call.
+                  "createTime": "A String", # Output only. Create time of the tool call.
+                  "inputParameters": { # Optional. The action's input parameters.
+                    "a_key": "", # Properties of the object.
+                  },
+                  "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`.
+                },
+                "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call.
+                  "action": "A String", # Optional. The name of the tool's action associated with this call.
+                  "content": "A String", # Only populated if the response content is utf-8 encoded.
+                  "createTime": "A String", # Output only. Create time of the tool call result.
+                  "error": { # An error produced by the tool call. # The tool call's error.
+                    "message": "A String", # Optional. The error message of the function.
+                  },
+                  "rawContent": "A String", # Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded).
+                  "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`.
+                },
+              },
+            ],
+          },
+          "summarizationSectionList": { # List of summarization sections. # Summarization sections.
+            "summarizationSections": [ # Optional. Summarization sections.
+              { # Represents the section of summarization.
+                "definition": "A String", # Optional. Definition of the section, for example, "what the customer needs help with or has question about."
+                "key": "A String", # Optional. Name of the section, for example, "situation".
+                "type": "A String", # Optional. Type of the summarization section.
+              },
+            ],
+          },
+        },
+      ],
+      "outputLanguageCode": "A String", # Optional. The target language of the generated summary. The language code for conversation will be used if this field is empty. Supported 2.0 and later versions.
+      "summarizationSections": [ # Optional. List of sections. Note it contains both predefined section sand customer defined sections.
+        { # Represents the section of summarization.
+          "definition": "A String", # Optional. Definition of the section, for example, "what the customer needs help with or has question about."
+          "key": "A String", # Optional. Name of the section, for example, "situation".
+          "type": "A String", # Optional. Type of the summarization section.
+        },
+      ],
+      "version": "A String", # Optional. Version of the feature. If not set, default to latest version. Current candidates are ["1.0"].
+    },
+    "tools": [ # Optional. Resource names of the tools that the generator can choose from. Format: `projects//locations//tools/`.
+      "A String",
+    ],
+    "triggerEvent": "A String", # Optional. The trigger event of the generator. It defines when the generator is triggered in a conversation.
+    "updateTime": "A String", # Output only. Update time of this generator.
+  },
+  "name": "A String", # Output only. Identifier. The resource name of the evaluation. Format: `projects//locations//generators// evaluations/`
+  "summarizationMetrics": { # Evaluation metrics for summarization generator. # Output only. Only available when the summarization generator is provided.
+    "conversationDetails": [ # Output only. List of conversation details.
+      { # Aggregated evaluation result on conversation level. This contains evaluation results of all the metrics and sections.
+        "messageEntries": [ # Output only. Conversation transcript that used for summarization evaluation as a reference.
+          { # Represents a message entry of a conversation.
+            "createTime": "A String", # Optional. Create time of the message entry.
+            "languageCode": "A String", # Optional. The language of the text. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.
+            "role": "A String", # Optional. Participant role of the message.
+            "text": "A String", # Optional. Transcript content of the message.
+          },
+        ],
+        "metricDetails": [ # Output only. List of metric details.
+          { # Aggregated result on metric level. This contains the evaluation results of all the sections.
+            "metric": "A String", # Output only. Metrics name. e.g. accuracy, adherence, completeness.
+            "score": 3.14, # Output only. Aggregated(average) score on this metric across all sections.
+            "sectionDetails": [ # Output only. List of section details.
+              { # Section level result.
+                "evaluationResults": [ # Output only. List of evaluation result. The list only contains one kind of the evaluation result.
+                  { # Evaluation result that contains one of accuracy, adherence or completeness evaluation result.
+                    "accuracyDecomposition": { # Decomposition details for accuracy. # Only available for accuracy metric.
+                      "accuracyReasoning": "A String", # Output only. The accuracy reasoning of the breakdown point.
+                      "isAccurate": True or False, # Output only. Whether the breakdown point is accurate or not.
+                      "point": "A String", # Output only. The breakdown point of the summary.
+                    },
+                    "adherenceRubric": { # Rubric result of the adherence evaluation. A rubric is ued to determine if the summary adheres to all aspects of the given instructions. # Only available for adherence metric.
+                      "isAddressed": True or False, # Output only. A boolean that indicates whether the rubric question is addressed or not.
+                      "question": "A String", # Output only. The question generated from instruction that used to evaluate summary.
+                      "reasoning": "A String", # Output only. The reasoning of the rubric question is addressed or not.
+                    },
+                    "completenessRubric": { # Rubric details of the completeness evaluation result. # Only available for completeness metric.
+                      "isAddressed": True or False, # Output only. A boolean that indicates whether the rubric question is addressed or not.
+                      "question": "A String", # Output only. The question generated from instruction that used to evaluate summary.
+                    },
+                  },
+                ],
+                "score": 3.14, # Output only. Aggregated(average) score on this section across all evaluation results. Either decompositions or rubrics.
+                "section": "A String", # Output only. The name of the summary instruction.
+                "sectionSummary": "A String", # Output only. Summary for this section
+              },
+            ],
+          },
+        ],
+        "sectionTokens": [ # Output only. Conversation level token count per section. This is an aggregated(sum) result of input token of summary acorss all metrics for a single conversation.
+          { # A pair of section name and input token count of the input summary section.
+            "section": "A String", # Output only. The name of the summary instruction.
+            "tokenCount": "A String", # Output only. Token count.
+          },
+        ],
+        "summarySections": [ # Output only. Summary sections that used for summarization evaluation as a reference.
+          { # A component of the generated summary.
+            "section": "A String", # Required. Name of the section.
+            "summary": "A String", # Required. Summary text for the section.
+          },
+        ],
+      },
+    ],
+    "overallMetrics": [ # Output only. A list of aggregated(average) scores per metric section.
+      { # Overall performance per metric. This is the aggregated score for each metric across all conversations that are selected for summarization evaluation.
+        "metric": "A String", # Output only. Metric name. e.g. accuracy, adherence, completeness.
+      },
+    ],
+    "overallSectionTokens": [ # Output only. Overall token per section. This is an aggregated(sum) result of input token of summary acorss all conversations that are selected for summarization evaluation.
+      { # A pair of section name and input token count of the input summary section.
+        "section": "A String", # Output only. The name of the summary instruction.
+        "tokenCount": "A String", # Output only. Token count.
+      },
+    ],
+    "summarizationEvaluationMergedResultsUri": "A String", # Output only. User bucket uri for merged evaluation score and aggregation score csv.
+    "summarizationEvaluationResults": [ # Output only. A list of evaluation results per conversation(&summary), metric and section.
+      { # Evaluation result per conversation(&summary), metric and section.
+        "decompositions": [ # Output only. List of decompostion details
+          { # Decomposition details
+            "accuracyDecomposition": { # Decomposition details for accuracy. # only available for accuracy metric.
+              "accuracyReasoning": "A String", # Output only. The accuracy reasoning of the breakdown point.
+              "isAccurate": True or False, # Output only. Whether the breakdown point is accurate or not.
+              "point": "A String", # Output only. The breakdown point of the summary.
+            },
+            "adherenceDecomposition": { # Decomposition details for adherence. # only available for adherence metric.
+              "adherenceReasoning": "A String", # Output only. The adherence reasoning of the breakdown point.
+              "isAdherent": True or False, # Output only. Whether the breakdown point is adherent or not.
+              "point": "A String", # Output only. The breakdown point of the given instructions.
+            },
+          },
+        ],
+        "evaluationResults": [ # Output only. List of evaluation results.
+          { # Evaluation result that contains one of accuracy, adherence or completeness evaluation result.
+            "accuracyDecomposition": { # Decomposition details for accuracy. # Only available for accuracy metric.
+              "accuracyReasoning": "A String", # Output only. The accuracy reasoning of the breakdown point.
+              "isAccurate": True or False, # Output only. Whether the breakdown point is accurate or not.
+              "point": "A String", # Output only. The breakdown point of the summary.
+            },
+            "adherenceRubric": { # Rubric result of the adherence evaluation. A rubric is ued to determine if the summary adheres to all aspects of the given instructions. # Only available for adherence metric.
+              "isAddressed": True or False, # Output only. A boolean that indicates whether the rubric question is addressed or not.
+              "question": "A String", # Output only. The question generated from instruction that used to evaluate summary.
+              "reasoning": "A String", # Output only. The reasoning of the rubric question is addressed or not.
+            },
+            "completenessRubric": { # Rubric details of the completeness evaluation result. # Only available for completeness metric.
+              "isAddressed": True or False, # Output only. A boolean that indicates whether the rubric question is addressed or not.
+              "question": "A String", # Output only. The question generated from instruction that used to evaluate summary.
+            },
+          },
+        ],
+        "metric": "A String", # Output only. metric name, e.g. accuracy, completeness, adherence, etc.
+        "score": 3.14, # Output only. score calculated from decompositions
+        "section": "A String", # Output only. section/task name, e.g. action, situation, etc
+        "sectionSummary": "A String", # Output only. Summary of this section
+        "sessionId": "A String", # Output only. conversation session id
+      },
+    ],
+  },
+}
+
+  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 an evaluation of generator.
+
+Args:
+  name: string, Required. The generator evaluation resource name. Format: `projects//locations//generators// evaluations/` (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 evaluation of generator.
+
+Args:
+  name: string, Required. The generator evaluation resource name. Format: `projects//locations//generators//evaluations/` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents evaluation result of a generator.
+  "completeTime": "A String", # Output only. Completion time of this generator evaluation.
+  "createTime": "A String", # Output only. Creation time of this generator evaluation.
+  "displayName": "A String", # Optional. The display name of the generator evaluation. At most 64 bytes long.
+  "evaluationStatus": { # A common evalaution pipeline status. # Output only. The result status of the evaluation pipeline. Provides the status information including if the evaluation is still in progress, completed or failed with certain error and user actionable message.
+    "done": True or False, # Output only. If the value is `false`, it means the evaluation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+    "pipelineStatus": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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 result of the evaluation in case of failure in evaluation pipeline.
+      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+      "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+        {
+          "a_key": "", # Properties of the object. Contains field @type with type URL.
+        },
+      ],
+      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+    },
+  },
+  "generatorEvaluationConfig": { # Generator evaluation input config. # Required. The configuration of the evaluation task.
+    "inputDataConfig": { # Input data config details # Required. The config/source of input data.
+      "agentAssistInputDataConfig": { # The distinctive configs for Agent Assist conversations as the conversation source. # The distinctive configs for Agent Assist conversations as the conversation source.
+        "endTime": "A String", # Required. The end of the time range for conversations to be evaluated. Only conversations ended at or before this timestamp will be sampled.
+        "startTime": "A String", # Required. The start of the time range for conversations to be evaluated. Only conversations created at or after this timestamp will be sampled.
+      },
+      "datasetInputDataConfig": { # The distinctive configs for dataset as the conversation source. # The distinctive configs for dataset as the conversation source.
+        "dataset": "A String", # Required. The identifier of the dataset to be evaluated. Format: `projects//locations//datasets/`.
+      },
+      "endTime": "A String", # Optional. The end timestamp to fetch conversation data.
+      "inputDataSourceType": "A String", # Required. The source type of input data.
+      "isSummaryGenerationAllowed": True or False, # Optional. Whether the summary generation is allowed when the pre-existing qualified summaries are insufficient to cover the sample size.
+      "sampleSize": 42, # Optional. Desired number of conversation-summary pairs to be evaluated.
+      "startTime": "A String", # Optional. The start timestamp to fetch conversation data.
+      "summaryGenerationOption": "A String", # Optional. Option to control whether summaries are generated during evaluation.
+    },
+    "outputGcsBucketPath": "A String", # Required. The output Cloud Storage bucket path to store eval files, e.g. per_summary_accuracy_score report. This path is provided by customer and files stored in it are visible to customer, no internal data should be stored in this path.
+    "summarizationConfig": { # Evaluation configs for summarization generator. # Evaluation configs for summarization generator.
+      "accuracyEvaluationVersion": "A String", # Optional. Version for summarization accuracy. This will determine the prompt and model used at backend.
+      "completenessEvaluationVersion": "A String", # Optional. Version for summarization completeness. This will determine the prompt and model used at backend.
+      "enableAccuracyEvaluation": True or False, # Optional. Enable accuracy evaluation.
+      "enableCompletenessEvaluation": True or False, # Optional. Enable completeness evaluation.
+      "evaluatorVersion": "A String", # Output only. Version for summarization evaluation.
+    },
+  },
+  "initialGenerator": { # LLM generator. # Required. The initial generator that was used when creating this evaluation. This is a copy of the generator read from storage when creating the evaluation.
+    "createTime": "A String", # Output only. Creation time of this generator.
+    "description": "A String", # Optional. Human readable description of the generator.
+    "freeFormContext": { # Free form generator context that customer can configure. # Input of free from generator to LLM.
+      "text": "A String", # Optional. Free form text input to LLM.
+    },
+    "inferenceParameter": { # The parameters of inference. # Optional. Inference parameters for this generator.
+      "maxOutputTokens": 42, # Optional. Maximum number of the output tokens for the generator.
+      "temperature": 3.14, # Optional. Controls the randomness of LLM predictions. Low temperature = less random. High temperature = more random. If unset (or 0), uses a default value of 0.
+      "topK": 42, # Optional. Top-k changes how the model selects tokens for output. A top-k of 1 means the selected token is the most probable among all tokens in the model's vocabulary (also called greedy decoding), while a top-k of 3 means that the next token is selected from among the 3 most probable tokens (using temperature). For each token selection step, the top K tokens with the highest probabilities are sampled. Then tokens are further filtered based on topP with the final token selected using temperature sampling. Specify a lower value for less random responses and a higher value for more random responses. Acceptable value is [1, 40], default to 40.
+      "topP": 3.14, # Optional. Top-p changes how the model selects tokens for output. Tokens are selected from most K (see topK parameter) probable to least until the sum of their probabilities equals the top-p value. For example, if tokens A, B, and C have a probability of 0.3, 0.2, and 0.1 and the top-p value is 0.5, then the model will select either A or B as the next token (using temperature) and doesn't consider C. The default top-p value is 0.95. Specify a lower value for less random responses and a higher value for more random responses. Acceptable value is [0.0, 1.0], default to 0.95.
+    },
+    "name": "A String", # Output only. Identifier. The resource name of the generator. Format: `projects//locations//generators/`
+    "publishedModel": "A String", # Optional. The published Large Language Model name. * To use the latest model version, specify the model name without version number. Example: `text-bison` * To use a stable model version, specify the version number as well. Example: `text-bison@002`.
+    "summarizationContext": { # Summarization context that customer can configure. # Input of Summarization feature.
+      "fewShotExamples": [ # Optional. List of few shot examples.
+        { # Providing examples in the generator (i.e. building a few-shot generator) helps convey the desired format of the LLM response.
+          "conversationContext": { # Context of the conversation, including transcripts. # Optional. Conversation transcripts.
+            "messageEntries": [ # Optional. List of message transcripts in the conversation.
+              { # Represents a message entry of a conversation.
+                "createTime": "A String", # Optional. Create time of the message entry.
+                "languageCode": "A String", # Optional. The language of the text. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.
+                "role": "A String", # Optional. Participant role of the message.
+                "text": "A String", # Optional. Transcript content of the message.
+              },
+            ],
+          },
+          "extraInfo": { # Optional. Key is the placeholder field name in input, value is the value of the placeholder. E.g. instruction contains "@price", and ingested data has <"price", "10">
+            "a_key": "A String",
+          },
+          "output": { # Suggestion generated using a Generator. # Required. Example output of the model.
+            "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion.
+              "response": "A String", # Required. Free form suggestion.
+            },
+            "summarySuggestion": { # Suggested summary of the conversation. # Optional. Suggested summary.
+              "summarySections": [ # Required. All the parts of generated summary.
+                { # A component of the generated summary.
+                  "section": "A String", # Required. Name of the section.
+                  "summary": "A String", # Required. Summary text for the section.
+                },
+              ],
+            },
+            "toolCallInfo": [ # Optional. List of request and response for tool calls executed.
+              { # Request and response for a tool call.
+                "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call.
+                  "action": "A String", # Optional. The name of the tool's action associated with this call.
+                  "createTime": "A String", # Output only. Create time of the tool call.
+                  "inputParameters": { # Optional. The action's input parameters.
+                    "a_key": "", # Properties of the object.
+                  },
+                  "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`.
+                },
+                "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call.
+                  "action": "A String", # Optional. The name of the tool's action associated with this call.
+                  "content": "A String", # Only populated if the response content is utf-8 encoded.
+                  "createTime": "A String", # Output only. Create time of the tool call result.
+                  "error": { # An error produced by the tool call. # The tool call's error.
+                    "message": "A String", # Optional. The error message of the function.
+                  },
+                  "rawContent": "A String", # Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded).
+                  "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`.
+                },
+              },
+            ],
+          },
+          "summarizationSectionList": { # List of summarization sections. # Summarization sections.
+            "summarizationSections": [ # Optional. Summarization sections.
+              { # Represents the section of summarization.
+                "definition": "A String", # Optional. Definition of the section, for example, "what the customer needs help with or has question about."
+                "key": "A String", # Optional. Name of the section, for example, "situation".
+                "type": "A String", # Optional. Type of the summarization section.
+              },
+            ],
+          },
+        },
+      ],
+      "outputLanguageCode": "A String", # Optional. The target language of the generated summary. The language code for conversation will be used if this field is empty. Supported 2.0 and later versions.
+      "summarizationSections": [ # Optional. List of sections. Note it contains both predefined section sand customer defined sections.
+        { # Represents the section of summarization.
+          "definition": "A String", # Optional. Definition of the section, for example, "what the customer needs help with or has question about."
+          "key": "A String", # Optional. Name of the section, for example, "situation".
+          "type": "A String", # Optional. Type of the summarization section.
+        },
+      ],
+      "version": "A String", # Optional. Version of the feature. If not set, default to latest version. Current candidates are ["1.0"].
+    },
+    "tools": [ # Optional. Resource names of the tools that the generator can choose from. Format: `projects//locations//tools/`.
+      "A String",
+    ],
+    "triggerEvent": "A String", # Optional. The trigger event of the generator. It defines when the generator is triggered in a conversation.
+    "updateTime": "A String", # Output only. Update time of this generator.
+  },
+  "name": "A String", # Output only. Identifier. The resource name of the evaluation. Format: `projects//locations//generators// evaluations/`
+  "summarizationMetrics": { # Evaluation metrics for summarization generator. # Output only. Only available when the summarization generator is provided.
+    "conversationDetails": [ # Output only. List of conversation details.
+      { # Aggregated evaluation result on conversation level. This contains evaluation results of all the metrics and sections.
+        "messageEntries": [ # Output only. Conversation transcript that used for summarization evaluation as a reference.
+          { # Represents a message entry of a conversation.
+            "createTime": "A String", # Optional. Create time of the message entry.
+            "languageCode": "A String", # Optional. The language of the text. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.
+            "role": "A String", # Optional. Participant role of the message.
+            "text": "A String", # Optional. Transcript content of the message.
+          },
+        ],
+        "metricDetails": [ # Output only. List of metric details.
+          { # Aggregated result on metric level. This contains the evaluation results of all the sections.
+            "metric": "A String", # Output only. Metrics name. e.g. accuracy, adherence, completeness.
+            "score": 3.14, # Output only. Aggregated(average) score on this metric across all sections.
+            "sectionDetails": [ # Output only. List of section details.
+              { # Section level result.
+                "evaluationResults": [ # Output only. List of evaluation result. The list only contains one kind of the evaluation result.
+                  { # Evaluation result that contains one of accuracy, adherence or completeness evaluation result.
+                    "accuracyDecomposition": { # Decomposition details for accuracy. # Only available for accuracy metric.
+                      "accuracyReasoning": "A String", # Output only. The accuracy reasoning of the breakdown point.
+                      "isAccurate": True or False, # Output only. Whether the breakdown point is accurate or not.
+                      "point": "A String", # Output only. The breakdown point of the summary.
+                    },
+                    "adherenceRubric": { # Rubric result of the adherence evaluation. A rubric is ued to determine if the summary adheres to all aspects of the given instructions. # Only available for adherence metric.
+                      "isAddressed": True or False, # Output only. A boolean that indicates whether the rubric question is addressed or not.
+                      "question": "A String", # Output only. The question generated from instruction that used to evaluate summary.
+                      "reasoning": "A String", # Output only. The reasoning of the rubric question is addressed or not.
+                    },
+                    "completenessRubric": { # Rubric details of the completeness evaluation result. # Only available for completeness metric.
+                      "isAddressed": True or False, # Output only. A boolean that indicates whether the rubric question is addressed or not.
+                      "question": "A String", # Output only. The question generated from instruction that used to evaluate summary.
+                    },
+                  },
+                ],
+                "score": 3.14, # Output only. Aggregated(average) score on this section across all evaluation results. Either decompositions or rubrics.
+                "section": "A String", # Output only. The name of the summary instruction.
+                "sectionSummary": "A String", # Output only. Summary for this section
+              },
+            ],
+          },
+        ],
+        "sectionTokens": [ # Output only. Conversation level token count per section. This is an aggregated(sum) result of input token of summary acorss all metrics for a single conversation.
+          { # A pair of section name and input token count of the input summary section.
+            "section": "A String", # Output only. The name of the summary instruction.
+            "tokenCount": "A String", # Output only. Token count.
+          },
+        ],
+        "summarySections": [ # Output only. Summary sections that used for summarization evaluation as a reference.
+          { # A component of the generated summary.
+            "section": "A String", # Required. Name of the section.
+            "summary": "A String", # Required. Summary text for the section.
+          },
+        ],
+      },
+    ],
+    "overallMetrics": [ # Output only. A list of aggregated(average) scores per metric section.
+      { # Overall performance per metric. This is the aggregated score for each metric across all conversations that are selected for summarization evaluation.
+        "metric": "A String", # Output only. Metric name. e.g. accuracy, adherence, completeness.
+      },
+    ],
+    "overallSectionTokens": [ # Output only. Overall token per section. This is an aggregated(sum) result of input token of summary acorss all conversations that are selected for summarization evaluation.
+      { # A pair of section name and input token count of the input summary section.
+        "section": "A String", # Output only. The name of the summary instruction.
+        "tokenCount": "A String", # Output only. Token count.
+      },
+    ],
+    "summarizationEvaluationMergedResultsUri": "A String", # Output only. User bucket uri for merged evaluation score and aggregation score csv.
+    "summarizationEvaluationResults": [ # Output only. A list of evaluation results per conversation(&summary), metric and section.
+      { # Evaluation result per conversation(&summary), metric and section.
+        "decompositions": [ # Output only. List of decompostion details
+          { # Decomposition details
+            "accuracyDecomposition": { # Decomposition details for accuracy. # only available for accuracy metric.
+              "accuracyReasoning": "A String", # Output only. The accuracy reasoning of the breakdown point.
+              "isAccurate": True or False, # Output only. Whether the breakdown point is accurate or not.
+              "point": "A String", # Output only. The breakdown point of the summary.
+            },
+            "adherenceDecomposition": { # Decomposition details for adherence. # only available for adherence metric.
+              "adherenceReasoning": "A String", # Output only. The adherence reasoning of the breakdown point.
+              "isAdherent": True or False, # Output only. Whether the breakdown point is adherent or not.
+              "point": "A String", # Output only. The breakdown point of the given instructions.
+            },
+          },
+        ],
+        "evaluationResults": [ # Output only. List of evaluation results.
+          { # Evaluation result that contains one of accuracy, adherence or completeness evaluation result.
+            "accuracyDecomposition": { # Decomposition details for accuracy. # Only available for accuracy metric.
+              "accuracyReasoning": "A String", # Output only. The accuracy reasoning of the breakdown point.
+              "isAccurate": True or False, # Output only. Whether the breakdown point is accurate or not.
+              "point": "A String", # Output only. The breakdown point of the summary.
+            },
+            "adherenceRubric": { # Rubric result of the adherence evaluation. A rubric is ued to determine if the summary adheres to all aspects of the given instructions. # Only available for adherence metric.
+              "isAddressed": True or False, # Output only. A boolean that indicates whether the rubric question is addressed or not.
+              "question": "A String", # Output only. The question generated from instruction that used to evaluate summary.
+              "reasoning": "A String", # Output only. The reasoning of the rubric question is addressed or not.
+            },
+            "completenessRubric": { # Rubric details of the completeness evaluation result. # Only available for completeness metric.
+              "isAddressed": True or False, # Output only. A boolean that indicates whether the rubric question is addressed or not.
+              "question": "A String", # Output only. The question generated from instruction that used to evaluate summary.
+            },
+          },
+        ],
+        "metric": "A String", # Output only. metric name, e.g. accuracy, completeness, adherence, etc.
+        "score": 3.14, # Output only. score calculated from decompositions
+        "section": "A String", # Output only. section/task name, e.g. action, situation, etc
+        "sectionSummary": "A String", # Output only. Summary of this section
+        "sessionId": "A String", # Output only. conversation session id
+      },
+    ],
+  },
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) + 
Lists evaluations of generator.
+
+Args:
+  parent: string, Required. The generator resource name. Format: `projects//locations//generators/` Wildcard value `-` is supported on generator_id to list evaluations across all generators under same project. (required)
+  pageSize: integer, Optional. Maximum number of evaluations to return in a single page. By default 100 and at most 1000.
+  pageToken: string, Optional. The next_page_token value returned from a previous list request.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response of ListGeneratorEvaluations.
+  "generatorEvaluations": [ # The list of evaluations to return.
+    { # Represents evaluation result of a generator.
+      "completeTime": "A String", # Output only. Completion time of this generator evaluation.
+      "createTime": "A String", # Output only. Creation time of this generator evaluation.
+      "displayName": "A String", # Optional. The display name of the generator evaluation. At most 64 bytes long.
+      "evaluationStatus": { # A common evalaution pipeline status. # Output only. The result status of the evaluation pipeline. Provides the status information including if the evaluation is still in progress, completed or failed with certain error and user actionable message.
+        "done": True or False, # Output only. If the value is `false`, it means the evaluation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+        "pipelineStatus": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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 result of the evaluation in case of failure in evaluation pipeline.
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+        },
+      },
+      "generatorEvaluationConfig": { # Generator evaluation input config. # Required. The configuration of the evaluation task.
+        "inputDataConfig": { # Input data config details # Required. The config/source of input data.
+          "agentAssistInputDataConfig": { # The distinctive configs for Agent Assist conversations as the conversation source. # The distinctive configs for Agent Assist conversations as the conversation source.
+            "endTime": "A String", # Required. The end of the time range for conversations to be evaluated. Only conversations ended at or before this timestamp will be sampled.
+            "startTime": "A String", # Required. The start of the time range for conversations to be evaluated. Only conversations created at or after this timestamp will be sampled.
+          },
+          "datasetInputDataConfig": { # The distinctive configs for dataset as the conversation source. # The distinctive configs for dataset as the conversation source.
+            "dataset": "A String", # Required. The identifier of the dataset to be evaluated. Format: `projects//locations//datasets/`.
+          },
+          "endTime": "A String", # Optional. The end timestamp to fetch conversation data.
+          "inputDataSourceType": "A String", # Required. The source type of input data.
+          "isSummaryGenerationAllowed": True or False, # Optional. Whether the summary generation is allowed when the pre-existing qualified summaries are insufficient to cover the sample size.
+          "sampleSize": 42, # Optional. Desired number of conversation-summary pairs to be evaluated.
+          "startTime": "A String", # Optional. The start timestamp to fetch conversation data.
+          "summaryGenerationOption": "A String", # Optional. Option to control whether summaries are generated during evaluation.
+        },
+        "outputGcsBucketPath": "A String", # Required. The output Cloud Storage bucket path to store eval files, e.g. per_summary_accuracy_score report. This path is provided by customer and files stored in it are visible to customer, no internal data should be stored in this path.
+        "summarizationConfig": { # Evaluation configs for summarization generator. # Evaluation configs for summarization generator.
+          "accuracyEvaluationVersion": "A String", # Optional. Version for summarization accuracy. This will determine the prompt and model used at backend.
+          "completenessEvaluationVersion": "A String", # Optional. Version for summarization completeness. This will determine the prompt and model used at backend.
+          "enableAccuracyEvaluation": True or False, # Optional. Enable accuracy evaluation.
+          "enableCompletenessEvaluation": True or False, # Optional. Enable completeness evaluation.
+          "evaluatorVersion": "A String", # Output only. Version for summarization evaluation.
+        },
+      },
+      "initialGenerator": { # LLM generator. # Required. The initial generator that was used when creating this evaluation. This is a copy of the generator read from storage when creating the evaluation.
+        "createTime": "A String", # Output only. Creation time of this generator.
+        "description": "A String", # Optional. Human readable description of the generator.
+        "freeFormContext": { # Free form generator context that customer can configure. # Input of free from generator to LLM.
+          "text": "A String", # Optional. Free form text input to LLM.
+        },
+        "inferenceParameter": { # The parameters of inference. # Optional. Inference parameters for this generator.
+          "maxOutputTokens": 42, # Optional. Maximum number of the output tokens for the generator.
+          "temperature": 3.14, # Optional. Controls the randomness of LLM predictions. Low temperature = less random. High temperature = more random. If unset (or 0), uses a default value of 0.
+          "topK": 42, # Optional. Top-k changes how the model selects tokens for output. A top-k of 1 means the selected token is the most probable among all tokens in the model's vocabulary (also called greedy decoding), while a top-k of 3 means that the next token is selected from among the 3 most probable tokens (using temperature). For each token selection step, the top K tokens with the highest probabilities are sampled. Then tokens are further filtered based on topP with the final token selected using temperature sampling. Specify a lower value for less random responses and a higher value for more random responses. Acceptable value is [1, 40], default to 40.
+          "topP": 3.14, # Optional. Top-p changes how the model selects tokens for output. Tokens are selected from most K (see topK parameter) probable to least until the sum of their probabilities equals the top-p value. For example, if tokens A, B, and C have a probability of 0.3, 0.2, and 0.1 and the top-p value is 0.5, then the model will select either A or B as the next token (using temperature) and doesn't consider C. The default top-p value is 0.95. Specify a lower value for less random responses and a higher value for more random responses. Acceptable value is [0.0, 1.0], default to 0.95.
+        },
+        "name": "A String", # Output only. Identifier. The resource name of the generator. Format: `projects//locations//generators/`
+        "publishedModel": "A String", # Optional. The published Large Language Model name. * To use the latest model version, specify the model name without version number. Example: `text-bison` * To use a stable model version, specify the version number as well. Example: `text-bison@002`.
+        "summarizationContext": { # Summarization context that customer can configure. # Input of Summarization feature.
+          "fewShotExamples": [ # Optional. List of few shot examples.
+            { # Providing examples in the generator (i.e. building a few-shot generator) helps convey the desired format of the LLM response.
+              "conversationContext": { # Context of the conversation, including transcripts. # Optional. Conversation transcripts.
+                "messageEntries": [ # Optional. List of message transcripts in the conversation.
+                  { # Represents a message entry of a conversation.
+                    "createTime": "A String", # Optional. Create time of the message entry.
+                    "languageCode": "A String", # Optional. The language of the text. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.
+                    "role": "A String", # Optional. Participant role of the message.
+                    "text": "A String", # Optional. Transcript content of the message.
+                  },
+                ],
+              },
+              "extraInfo": { # Optional. Key is the placeholder field name in input, value is the value of the placeholder. E.g. instruction contains "@price", and ingested data has <"price", "10">
+                "a_key": "A String",
+              },
+              "output": { # Suggestion generated using a Generator. # Required. Example output of the model.
+                "freeFormSuggestion": { # Suggestion generated using free form generator. # Optional. Free form suggestion.
+                  "response": "A String", # Required. Free form suggestion.
+                },
+                "summarySuggestion": { # Suggested summary of the conversation. # Optional. Suggested summary.
+                  "summarySections": [ # Required. All the parts of generated summary.
+                    { # A component of the generated summary.
+                      "section": "A String", # Required. Name of the section.
+                      "summary": "A String", # Required. Summary text for the section.
+                    },
+                  ],
+                },
+                "toolCallInfo": [ # Optional. List of request and response for tool calls executed.
+                  { # Request and response for a tool call.
+                    "toolCall": { # Represents a call of a specific tool's action with the specified inputs. # Required. Request for a tool call.
+                      "action": "A String", # Optional. The name of the tool's action associated with this call.
+                      "createTime": "A String", # Output only. Create time of the tool call.
+                      "inputParameters": { # Optional. The action's input parameters.
+                        "a_key": "", # Properties of the object.
+                      },
+                      "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`.
+                    },
+                    "toolCallResult": { # The result of calling a tool's action. # Required. Response for a tool call.
+                      "action": "A String", # Optional. The name of the tool's action associated with this call.
+                      "content": "A String", # Only populated if the response content is utf-8 encoded.
+                      "createTime": "A String", # Output only. Create time of the tool call result.
+                      "error": { # An error produced by the tool call. # The tool call's error.
+                        "message": "A String", # Optional. The error message of the function.
+                      },
+                      "rawContent": "A String", # Only populated if the response content is not utf-8 encoded. (by definition byte fields are base64 encoded).
+                      "tool": "A String", # Optional. The tool associated with this call. Format: `projects//locations//tools/`.
+                    },
+                  },
+                ],
+              },
+              "summarizationSectionList": { # List of summarization sections. # Summarization sections.
+                "summarizationSections": [ # Optional. Summarization sections.
+                  { # Represents the section of summarization.
+                    "definition": "A String", # Optional. Definition of the section, for example, "what the customer needs help with or has question about."
+                    "key": "A String", # Optional. Name of the section, for example, "situation".
+                    "type": "A String", # Optional. Type of the summarization section.
+                  },
+                ],
+              },
+            },
+          ],
+          "outputLanguageCode": "A String", # Optional. The target language of the generated summary. The language code for conversation will be used if this field is empty. Supported 2.0 and later versions.
+          "summarizationSections": [ # Optional. List of sections. Note it contains both predefined section sand customer defined sections.
+            { # Represents the section of summarization.
+              "definition": "A String", # Optional. Definition of the section, for example, "what the customer needs help with or has question about."
+              "key": "A String", # Optional. Name of the section, for example, "situation".
+              "type": "A String", # Optional. Type of the summarization section.
+            },
+          ],
+          "version": "A String", # Optional. Version of the feature. If not set, default to latest version. Current candidates are ["1.0"].
+        },
+        "tools": [ # Optional. Resource names of the tools that the generator can choose from. Format: `projects//locations//tools/`.
+          "A String",
+        ],
+        "triggerEvent": "A String", # Optional. The trigger event of the generator. It defines when the generator is triggered in a conversation.
+        "updateTime": "A String", # Output only. Update time of this generator.
+      },
+      "name": "A String", # Output only. Identifier. The resource name of the evaluation. Format: `projects//locations//generators// evaluations/`
+      "summarizationMetrics": { # Evaluation metrics for summarization generator. # Output only. Only available when the summarization generator is provided.
+        "conversationDetails": [ # Output only. List of conversation details.
+          { # Aggregated evaluation result on conversation level. This contains evaluation results of all the metrics and sections.
+            "messageEntries": [ # Output only. Conversation transcript that used for summarization evaluation as a reference.
+              { # Represents a message entry of a conversation.
+                "createTime": "A String", # Optional. Create time of the message entry.
+                "languageCode": "A String", # Optional. The language of the text. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.
+                "role": "A String", # Optional. Participant role of the message.
+                "text": "A String", # Optional. Transcript content of the message.
+              },
+            ],
+            "metricDetails": [ # Output only. List of metric details.
+              { # Aggregated result on metric level. This contains the evaluation results of all the sections.
+                "metric": "A String", # Output only. Metrics name. e.g. accuracy, adherence, completeness.
+                "score": 3.14, # Output only. Aggregated(average) score on this metric across all sections.
+                "sectionDetails": [ # Output only. List of section details.
+                  { # Section level result.
+                    "evaluationResults": [ # Output only. List of evaluation result. The list only contains one kind of the evaluation result.
+                      { # Evaluation result that contains one of accuracy, adherence or completeness evaluation result.
+                        "accuracyDecomposition": { # Decomposition details for accuracy. # Only available for accuracy metric.
+                          "accuracyReasoning": "A String", # Output only. The accuracy reasoning of the breakdown point.
+                          "isAccurate": True or False, # Output only. Whether the breakdown point is accurate or not.
+                          "point": "A String", # Output only. The breakdown point of the summary.
+                        },
+                        "adherenceRubric": { # Rubric result of the adherence evaluation. A rubric is ued to determine if the summary adheres to all aspects of the given instructions. # Only available for adherence metric.
+                          "isAddressed": True or False, # Output only. A boolean that indicates whether the rubric question is addressed or not.
+                          "question": "A String", # Output only. The question generated from instruction that used to evaluate summary.
+                          "reasoning": "A String", # Output only. The reasoning of the rubric question is addressed or not.
+                        },
+                        "completenessRubric": { # Rubric details of the completeness evaluation result. # Only available for completeness metric.
+                          "isAddressed": True or False, # Output only. A boolean that indicates whether the rubric question is addressed or not.
+                          "question": "A String", # Output only. The question generated from instruction that used to evaluate summary.
+                        },
+                      },
+                    ],
+                    "score": 3.14, # Output only. Aggregated(average) score on this section across all evaluation results. Either decompositions or rubrics.
+                    "section": "A String", # Output only. The name of the summary instruction.
+                    "sectionSummary": "A String", # Output only. Summary for this section
+                  },
+                ],
+              },
+            ],
+            "sectionTokens": [ # Output only. Conversation level token count per section. This is an aggregated(sum) result of input token of summary acorss all metrics for a single conversation.
+              { # A pair of section name and input token count of the input summary section.
+                "section": "A String", # Output only. The name of the summary instruction.
+                "tokenCount": "A String", # Output only. Token count.
+              },
+            ],
+            "summarySections": [ # Output only. Summary sections that used for summarization evaluation as a reference.
+              { # A component of the generated summary.
+                "section": "A String", # Required. Name of the section.
+                "summary": "A String", # Required. Summary text for the section.
+              },
+            ],
+          },
+        ],
+        "overallMetrics": [ # Output only. A list of aggregated(average) scores per metric section.
+          { # Overall performance per metric. This is the aggregated score for each metric across all conversations that are selected for summarization evaluation.
+            "metric": "A String", # Output only. Metric name. e.g. accuracy, adherence, completeness.
+          },
+        ],
+        "overallSectionTokens": [ # Output only. Overall token per section. This is an aggregated(sum) result of input token of summary acorss all conversations that are selected for summarization evaluation.
+          { # A pair of section name and input token count of the input summary section.
+            "section": "A String", # Output only. The name of the summary instruction.
+            "tokenCount": "A String", # Output only. Token count.
+          },
+        ],
+        "summarizationEvaluationMergedResultsUri": "A String", # Output only. User bucket uri for merged evaluation score and aggregation score csv.
+        "summarizationEvaluationResults": [ # Output only. A list of evaluation results per conversation(&summary), metric and section.
+          { # Evaluation result per conversation(&summary), metric and section.
+            "decompositions": [ # Output only. List of decompostion details
+              { # Decomposition details
+                "accuracyDecomposition": { # Decomposition details for accuracy. # only available for accuracy metric.
+                  "accuracyReasoning": "A String", # Output only. The accuracy reasoning of the breakdown point.
+                  "isAccurate": True or False, # Output only. Whether the breakdown point is accurate or not.
+                  "point": "A String", # Output only. The breakdown point of the summary.
+                },
+                "adherenceDecomposition": { # Decomposition details for adherence. # only available for adherence metric.
+                  "adherenceReasoning": "A String", # Output only. The adherence reasoning of the breakdown point.
+                  "isAdherent": True or False, # Output only. Whether the breakdown point is adherent or not.
+                  "point": "A String", # Output only. The breakdown point of the given instructions.
+                },
+              },
+            ],
+            "evaluationResults": [ # Output only. List of evaluation results.
+              { # Evaluation result that contains one of accuracy, adherence or completeness evaluation result.
+                "accuracyDecomposition": { # Decomposition details for accuracy. # Only available for accuracy metric.
+                  "accuracyReasoning": "A String", # Output only. The accuracy reasoning of the breakdown point.
+                  "isAccurate": True or False, # Output only. Whether the breakdown point is accurate or not.
+                  "point": "A String", # Output only. The breakdown point of the summary.
+                },
+                "adherenceRubric": { # Rubric result of the adherence evaluation. A rubric is ued to determine if the summary adheres to all aspects of the given instructions. # Only available for adherence metric.
+                  "isAddressed": True or False, # Output only. A boolean that indicates whether the rubric question is addressed or not.
+                  "question": "A String", # Output only. The question generated from instruction that used to evaluate summary.
+                  "reasoning": "A String", # Output only. The reasoning of the rubric question is addressed or not.
+                },
+                "completenessRubric": { # Rubric details of the completeness evaluation result. # Only available for completeness metric.
+                  "isAddressed": True or False, # Output only. A boolean that indicates whether the rubric question is addressed or not.
+                  "question": "A String", # Output only. The question generated from instruction that used to evaluate summary.
+                },
+              },
+            ],
+            "metric": "A String", # Output only. metric name, e.g. accuracy, completeness, adherence, etc.
+            "score": 3.14, # Output only. score calculated from decompositions
+            "section": "A String", # Output only. section/task name, e.g. action, situation, etc
+            "sectionSummary": "A String", # Output only. Summary of this section
+            "sessionId": "A String", # Output only. conversation session id
+          },
+        ],
+      },
+    },
+  ],
+  "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
+}
+
+ +
+ 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/dialogflow_v2beta1.projects.locations.generators.html b/docs/dyn/dialogflow_v2beta1.projects.locations.generators.html index b21d7c9dd01..fbde9d39661 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.generators.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.generators.html @@ -74,6 +74,11 @@

Dialogflow API . projects . locations . generators

Instance Methods

+

+ evaluations() +

+

Returns the evaluations Resource.

+

close()

Close httplib2 connections.

diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.html b/docs/dyn/dialogflow_v2beta1.projects.locations.html index ad5cf294217..6ed5182a8b4 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.html @@ -267,7 +267,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - 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) + 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/dialogflow_v3.projects.locations.html b/docs/dyn/dialogflow_v3.projects.locations.html index 0ce5e9d198c..e1922b74b57 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. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (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/dialogflow_v3beta1.projects.locations.html b/docs/dyn/dialogflow_v3beta1.projects.locations.html index 32cc22f231c..a5426487da3 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. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (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/googleapiclient/discovery_cache/documents/dialogflow.v2.json b/googleapiclient/discovery_cache/documents/dialogflow.v2.json index af2cc920513..958b519d1b3 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. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", +"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" @@ -8027,6 +8027,130 @@ "https://www.googleapis.com/auth/dialogflow" ] } +}, +"resources": { +"evaluations": { +"methods": { +"create": { +"description": "Creates evaluation of a generator.", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/generators/{generatorsId}/evaluations", +"httpMethod": "POST", +"id": "dialogflow.projects.locations.generators.evaluations.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The generator resource name. Format: `projects//locations//generators/`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/generators/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+parent}/evaluations", +"request": { +"$ref": "GoogleCloudDialogflowV2GeneratorEvaluation" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +}, +"delete": { +"description": "Deletes an evaluation of generator.", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/generators/{generatorsId}/evaluations/{evaluationsId}", +"httpMethod": "DELETE", +"id": "dialogflow.projects.locations.generators.evaluations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The generator evaluation resource name. Format: `projects//locations//generators// evaluations/`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/generators/[^/]+/evaluations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +}, +"get": { +"description": "Gets an evaluation of generator.", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/generators/{generatorsId}/evaluations/{evaluationsId}", +"httpMethod": "GET", +"id": "dialogflow.projects.locations.generators.evaluations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The generator evaluation resource name. Format: `projects//locations//generators//evaluations/`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/generators/[^/]+/evaluations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+name}", +"response": { +"$ref": "GoogleCloudDialogflowV2GeneratorEvaluation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +}, +"list": { +"description": "Lists evaluations of generator.", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/generators/{generatorsId}/evaluations", +"httpMethod": "GET", +"id": "dialogflow.projects.locations.generators.evaluations.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. Maximum number of evaluations to return in a single page. By default 100 and at most 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The next_page_token value returned from a previous list request.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The generator resource name. Format: `projects//locations//generators/` Wildcard value `-` is supported on generator_id to list evaluations across all generators under same project.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/generators/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+parent}/evaluations", +"response": { +"$ref": "GoogleCloudDialogflowV2ListGeneratorEvaluationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +} +} +} } }, "knowledgeBases": { @@ -8962,7 +9086,7 @@ } } }, -"revision": "20250902", +"revision": "20250919", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -15948,6 +16072,23 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2EvaluationStatus": { +"description": "A common evalaution pipeline status.", +"id": "GoogleCloudDialogflowV2EvaluationStatus", +"properties": { +"done": { +"description": "Output only. If the value is `false`, it means the evaluation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", +"readOnly": true, +"type": "boolean" +}, +"pipelineStatus": { +"$ref": "GoogleRpcStatus", +"description": "Output only. The error result of the evaluation in case of failure in evaluation pipeline.", +"readOnly": true +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2EventInput": { "description": "Events allow for matching intents by event name instead of the natural language input. For instance, input `` can trigger a personalized welcome response. The parameter `name` may be used by the agent in the response: `\"Hello #welcome_event.name! What can I do for you today?\"`.", "id": "GoogleCloudDialogflowV2EventInput", @@ -16496,6 +16637,199 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2GeneratorEvaluation": { +"description": "Represents evaluation result of a generator.", +"id": "GoogleCloudDialogflowV2GeneratorEvaluation", +"properties": { +"completeTime": { +"description": "Output only. Completion time of this generator evaluation.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"createTime": { +"description": "Output only. Creation time of this generator evaluation.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "Optional. The display name of the generator evaluation. At most 64 bytes long.", +"type": "string" +}, +"evaluationStatus": { +"$ref": "GoogleCloudDialogflowV2EvaluationStatus", +"description": "Output only. The result status of the evaluation pipeline. Provides the status information including if the evaluation is still in progress, completed or failed with certain error and user actionable message.", +"readOnly": true +}, +"generatorEvaluationConfig": { +"$ref": "GoogleCloudDialogflowV2GeneratorEvaluationConfig", +"description": "Required. The configuration of the evaluation task." +}, +"initialGenerator": { +"$ref": "GoogleCloudDialogflowV2Generator", +"description": "Required. The initial generator that was used when creating this evaluation. This is a copy of the generator read from storage when creating the evaluation." +}, +"name": { +"description": "Output only. Identifier. The resource name of the evaluation. Format: `projects//locations//generators// evaluations/`", +"readOnly": true, +"type": "string" +}, +"summarizationMetrics": { +"$ref": "GoogleCloudDialogflowV2SummarizationEvaluationMetrics", +"description": "Output only. Only available when the summarization generator is provided.", +"readOnly": true +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2GeneratorEvaluationConfig": { +"description": "Generator evaluation input config.", +"id": "GoogleCloudDialogflowV2GeneratorEvaluationConfig", +"properties": { +"inputDataConfig": { +"$ref": "GoogleCloudDialogflowV2GeneratorEvaluationConfigInputDataConfig", +"description": "Required. The config/source of input data." +}, +"outputGcsBucketPath": { +"description": "Required. The output Cloud Storage bucket path to store eval files, e.g. per_summary_accuracy_score report. This path is provided by customer and files stored in it are visible to customer, no internal data should be stored in this path.", +"type": "string" +}, +"summarizationConfig": { +"$ref": "GoogleCloudDialogflowV2GeneratorEvaluationConfigSummarizationConfig", +"description": "Evaluation configs for summarization generator." +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2GeneratorEvaluationConfigAgentAssistInputDataConfig": { +"description": "The distinctive configs for Agent Assist conversations as the conversation source.", +"id": "GoogleCloudDialogflowV2GeneratorEvaluationConfigAgentAssistInputDataConfig", +"properties": { +"endTime": { +"description": "Required. The end of the time range for conversations to be evaluated. Only conversations ended at or before this timestamp will be sampled.", +"format": "google-datetime", +"type": "string" +}, +"startTime": { +"description": "Required. The start of the time range for conversations to be evaluated. Only conversations created at or after this timestamp will be sampled.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2GeneratorEvaluationConfigDatasetInputDataConfig": { +"description": "The distinctive configs for dataset as the conversation source.", +"id": "GoogleCloudDialogflowV2GeneratorEvaluationConfigDatasetInputDataConfig", +"properties": { +"dataset": { +"description": "Required. The identifier of the dataset to be evaluated. Format: `projects//locations//datasets/`.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2GeneratorEvaluationConfigInputDataConfig": { +"description": "Input data config details", +"id": "GoogleCloudDialogflowV2GeneratorEvaluationConfigInputDataConfig", +"properties": { +"agentAssistInputDataConfig": { +"$ref": "GoogleCloudDialogflowV2GeneratorEvaluationConfigAgentAssistInputDataConfig", +"description": "The distinctive configs for Agent Assist conversations as the conversation source." +}, +"datasetInputDataConfig": { +"$ref": "GoogleCloudDialogflowV2GeneratorEvaluationConfigDatasetInputDataConfig", +"description": "The distinctive configs for dataset as the conversation source." +}, +"endTime": { +"deprecated": true, +"description": "Optional. The end timestamp to fetch conversation data.", +"format": "google-datetime", +"type": "string" +}, +"inputDataSourceType": { +"deprecated": true, +"description": "Required. The source type of input data.", +"enum": [ +"INPUT_DATA_SOURCE_TYPE_UNSPECIFIED", +"AGENT_ASSIST_CONVERSATIONS", +"INSIGHTS_CONVERSATIONS" +], +"enumDescriptions": [ +"Unspecified InputDataSourceType. Should not be used.", +"Fetch data from Agent Assist storage. If this source type is chosen, input_data_config.start_time and input_data_config.end_timestamp must be provided.", +"Fetch data from Insights storage. If this source type is chosen, input_data_config.start_time and input_data_config.end_timestamp must be provided." +], +"type": "string" +}, +"isSummaryGenerationAllowed": { +"deprecated": true, +"description": "Optional. Whether the summary generation is allowed when the pre-existing qualified summaries are insufficient to cover the sample size.", +"type": "boolean" +}, +"sampleSize": { +"description": "Optional. Desired number of conversation-summary pairs to be evaluated.", +"format": "int32", +"type": "integer" +}, +"startTime": { +"deprecated": true, +"description": "Optional. The start timestamp to fetch conversation data.", +"format": "google-datetime", +"type": "string" +}, +"summaryGenerationOption": { +"description": "Optional. Option to control whether summaries are generated during evaluation.", +"enum": [ +"SUMMARY_GENERATION_OPTION_UNSPECIFIED", +"ALWAYS_GENERATE", +"GENERATE_IF_MISSING", +"DO_NOT_GENERATE" +], +"enumDescriptions": [ +"Default option will not be used", +"Always Generate summary for all conversations.", +"Gnerate only missing summaries.", +"Do not generate new summaries. Only use existing summaries found." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2GeneratorEvaluationConfigSummarizationConfig": { +"description": "Evaluation configs for summarization generator.", +"id": "GoogleCloudDialogflowV2GeneratorEvaluationConfigSummarizationConfig", +"properties": { +"accuracyEvaluationVersion": { +"deprecated": true, +"description": "Optional. Version for summarization accuracy. This will determine the prompt and model used at backend.", +"type": "string" +}, +"completenessEvaluationVersion": { +"deprecated": true, +"description": "Optional. Version for summarization completeness. This will determine the prompt and model used at backend.", +"type": "string" +}, +"enableAccuracyEvaluation": { +"deprecated": true, +"description": "Optional. Enable accuracy evaluation.", +"type": "boolean" +}, +"enableCompletenessEvaluation": { +"deprecated": true, +"description": "Optional. Enable completeness evaluation.", +"type": "boolean" +}, +"evaluatorVersion": { +"description": "Output only. Version for summarization evaluation.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2GeneratorSuggestion": { "description": "Suggestion generated using a Generator.", "id": "GoogleCloudDialogflowV2GeneratorSuggestion", @@ -18535,6 +18869,24 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2ListGeneratorEvaluationsResponse": { +"description": "Response of ListGeneratorEvaluations.", +"id": "GoogleCloudDialogflowV2ListGeneratorEvaluationsResponse", +"properties": { +"generatorEvaluations": { +"description": "The list of evaluations to return.", +"items": { +"$ref": "GoogleCloudDialogflowV2GeneratorEvaluation" +}, +"type": "array" +}, +"nextPageToken": { +"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2ListGeneratorsResponse": { "description": "Response of ListGenerators.", "id": "GoogleCloudDialogflowV2ListGeneratorsResponse", @@ -20240,6 +20592,346 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2SummarizationEvaluationMetrics": { +"description": "Evaluation metrics for summarization generator.", +"id": "GoogleCloudDialogflowV2SummarizationEvaluationMetrics", +"properties": { +"conversationDetails": { +"description": "Output only. List of conversation details.", +"items": { +"$ref": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsConversationDetail" +}, +"readOnly": true, +"type": "array" +}, +"overallMetrics": { +"description": "Output only. A list of aggregated(average) scores per metric section.", +"items": { +"$ref": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsOverallScoresByMetric" +}, +"readOnly": true, +"type": "array" +}, +"overallSectionTokens": { +"description": "Output only. Overall token per section. This is an aggregated(sum) result of input token of summary acorss all conversations that are selected for summarization evaluation.", +"items": { +"$ref": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsSectionToken" +}, +"readOnly": true, +"type": "array" +}, +"summarizationEvaluationMergedResultsUri": { +"description": "Output only. User bucket uri for merged evaluation score and aggregation score csv.", +"readOnly": true, +"type": "string" +}, +"summarizationEvaluationResults": { +"description": "Output only. A list of evaluation results per conversation(&summary), metric and section.", +"items": { +"$ref": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsSummarizationEvaluationResult" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2SummarizationEvaluationMetricsAccuracyDecomposition": { +"description": "Decomposition details for accuracy.", +"id": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsAccuracyDecomposition", +"properties": { +"accuracyReasoning": { +"description": "Output only. The accuracy reasoning of the breakdown point.", +"readOnly": true, +"type": "string" +}, +"isAccurate": { +"description": "Output only. Whether the breakdown point is accurate or not.", +"readOnly": true, +"type": "boolean" +}, +"point": { +"description": "Output only. The breakdown point of the summary.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2SummarizationEvaluationMetricsAdherenceDecomposition": { +"deprecated": true, +"description": "Decomposition details for adherence.", +"id": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsAdherenceDecomposition", +"properties": { +"adherenceReasoning": { +"description": "Output only. The adherence reasoning of the breakdown point.", +"readOnly": true, +"type": "string" +}, +"isAdherent": { +"description": "Output only. Whether the breakdown point is adherent or not.", +"readOnly": true, +"type": "boolean" +}, +"point": { +"description": "Output only. The breakdown point of the given instructions.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2SummarizationEvaluationMetricsAdherenceRubric": { +"description": "Rubric result of the adherence evaluation. A rubric is ued to determine if the summary adheres to all aspects of the given instructions.", +"id": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsAdherenceRubric", +"properties": { +"isAddressed": { +"description": "Output only. A boolean that indicates whether the rubric question is addressed or not.", +"readOnly": true, +"type": "boolean" +}, +"question": { +"description": "Output only. The question generated from instruction that used to evaluate summary.", +"readOnly": true, +"type": "string" +}, +"reasoning": { +"description": "Output only. The reasoning of the rubric question is addressed or not.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2SummarizationEvaluationMetricsCompletenessRubric": { +"description": "Rubric details of the completeness evaluation result.", +"id": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsCompletenessRubric", +"properties": { +"isAddressed": { +"description": "Output only. A boolean that indicates whether the rubric question is addressed or not.", +"readOnly": true, +"type": "boolean" +}, +"question": { +"description": "Output only. The question generated from instruction that used to evaluate summary.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2SummarizationEvaluationMetricsConversationDetail": { +"description": "Aggregated evaluation result on conversation level. This conatins evaluation results of all the metrics and sections.", +"id": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsConversationDetail", +"properties": { +"messageEntries": { +"description": "Output only. Conversation transcript that used for summarization evaluation as a reference.", +"items": { +"$ref": "GoogleCloudDialogflowV2MessageEntry" +}, +"readOnly": true, +"type": "array" +}, +"metricDetails": { +"description": "Output only. List of metric details.", +"items": { +"$ref": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsConversationDetailMetricDetail" +}, +"readOnly": true, +"type": "array" +}, +"sectionTokens": { +"description": "Output only. Conversation level token count per section. This is an aggregated(sum) result of input token of summary acorss all metrics for a single conversation.", +"items": { +"$ref": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsSectionToken" +}, +"readOnly": true, +"type": "array" +}, +"summarySections": { +"description": "Output only. Summary sections that used for summarization evaluation as a reference.", +"items": { +"$ref": "GoogleCloudDialogflowV2SummarySuggestionSummarySection" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2SummarizationEvaluationMetricsConversationDetailMetricDetail": { +"description": "Aggregated result on metric level. This conatins the evaluation results of all the sections.", +"id": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsConversationDetailMetricDetail", +"properties": { +"metric": { +"description": "Output only. Metrics name. e.g. accuracy, adherence, completeness.", +"readOnly": true, +"type": "string" +}, +"score": { +"description": "Output only. Aggregated(average) score on this metric across all sections.", +"format": "float", +"readOnly": true, +"type": "number" +}, +"sectionDetails": { +"description": "Output only. List of section details.", +"items": { +"$ref": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsConversationDetailMetricDetailSectionDetail" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2SummarizationEvaluationMetricsConversationDetailMetricDetailSectionDetail": { +"description": "Section level result.", +"id": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsConversationDetailMetricDetailSectionDetail", +"properties": { +"evaluationResults": { +"description": "Output only. List of evaluation result. The list only contains one kind of the evaluation result.", +"items": { +"$ref": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsEvaluationResult" +}, +"readOnly": true, +"type": "array" +}, +"score": { +"description": "Output only. Aggregated(average) score on this section across all evaluation results. Either decompositions or rubrics.", +"format": "float", +"readOnly": true, +"type": "number" +}, +"section": { +"description": "Output only. The name of the summary instruction.", +"readOnly": true, +"type": "string" +}, +"sectionSummary": { +"description": "Output only. Summary for this section", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2SummarizationEvaluationMetricsDecomposition": { +"deprecated": true, +"description": "Decomposition details", +"id": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsDecomposition", +"properties": { +"accuracyDecomposition": { +"$ref": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsAccuracyDecomposition", +"description": "only available for accuracy metric." +}, +"adherenceDecomposition": { +"$ref": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsAdherenceDecomposition", +"description": "only available for adherence metric." +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2SummarizationEvaluationMetricsEvaluationResult": { +"description": "Evaluation result that contains one of accuracy, adherence or completeness evaluation result.", +"id": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsEvaluationResult", +"properties": { +"accuracyDecomposition": { +"$ref": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsAccuracyDecomposition", +"description": "Only available for accuracy metric." +}, +"adherenceRubric": { +"$ref": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsAdherenceRubric", +"description": "Only available for adherence metric." +}, +"completenessRubric": { +"$ref": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsCompletenessRubric", +"description": "Only available for completeness metric." +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2SummarizationEvaluationMetricsOverallScoresByMetric": { +"description": "Overall performance per metric. This is the aggregated score for each metric across all conversations that are selected for summarization evaluation.", +"id": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsOverallScoresByMetric", +"properties": { +"metric": { +"description": "Output only. Metric name. e.g. accuracy, adherence, completeness.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2SummarizationEvaluationMetricsSectionToken": { +"description": "A pair of section name and input token count of the input summary section.", +"id": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsSectionToken", +"properties": { +"section": { +"description": "Output only. The name of the summary instruction.", +"readOnly": true, +"type": "string" +}, +"tokenCount": { +"description": "Output only. Token count.", +"format": "int64", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2SummarizationEvaluationMetricsSummarizationEvaluationResult": { +"description": "Evaluation result per conversation(&summary), metric and section.", +"id": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsSummarizationEvaluationResult", +"properties": { +"decompositions": { +"deprecated": true, +"description": "Output only. List of decompostion details", +"items": { +"$ref": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsDecomposition" +}, +"readOnly": true, +"type": "array" +}, +"evaluationResults": { +"description": "Output only. List of evaluation results.", +"items": { +"$ref": "GoogleCloudDialogflowV2SummarizationEvaluationMetricsEvaluationResult" +}, +"readOnly": true, +"type": "array" +}, +"metric": { +"description": "Output only. metric name, e.g. accuracy, completeness, adherence, etc.", +"readOnly": true, +"type": "string" +}, +"score": { +"description": "Output only. score calculated from decompositions", +"format": "float", +"readOnly": true, +"type": "number" +}, +"section": { +"description": "Output only. section/task name, e.g. action, situation, etc", +"readOnly": true, +"type": "string" +}, +"sectionSummary": { +"description": "Output only. Summary of this section", +"readOnly": true, +"type": "string" +}, +"sessionId": { +"deprecated": true, +"description": "Output only. conversation session id", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2SummarizationSection": { "description": "Represents the section of summarization.", "id": "GoogleCloudDialogflowV2SummarizationSection", diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json b/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json index 47a93764719..ee4ceed08dc 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. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", +"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" @@ -7419,6 +7419,130 @@ "https://www.googleapis.com/auth/dialogflow" ] } +}, +"resources": { +"evaluations": { +"methods": { +"create": { +"description": "Creates evaluation of a generator.", +"flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/generators/{generatorsId}/evaluations", +"httpMethod": "POST", +"id": "dialogflow.projects.locations.generators.evaluations.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The generator resource name. Format: `projects//locations//generators/`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/generators/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2beta1/{+parent}/evaluations", +"request": { +"$ref": "GoogleCloudDialogflowV2beta1GeneratorEvaluation" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +}, +"delete": { +"description": "Deletes an evaluation of generator.", +"flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/generators/{generatorsId}/evaluations/{evaluationsId}", +"httpMethod": "DELETE", +"id": "dialogflow.projects.locations.generators.evaluations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The generator evaluation resource name. Format: `projects//locations//generators// evaluations/`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/generators/[^/]+/evaluations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2beta1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +}, +"get": { +"description": "Gets an evaluation of generator.", +"flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/generators/{generatorsId}/evaluations/{evaluationsId}", +"httpMethod": "GET", +"id": "dialogflow.projects.locations.generators.evaluations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The generator evaluation resource name. Format: `projects//locations//generators//evaluations/`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/generators/[^/]+/evaluations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2beta1/{+name}", +"response": { +"$ref": "GoogleCloudDialogflowV2beta1GeneratorEvaluation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +}, +"list": { +"description": "Lists evaluations of generator.", +"flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/generators/{generatorsId}/evaluations", +"httpMethod": "GET", +"id": "dialogflow.projects.locations.generators.evaluations.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. Maximum number of evaluations to return in a single page. By default 100 and at most 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The next_page_token value returned from a previous list request.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The generator resource name. Format: `projects//locations//generators/` Wildcard value `-` is supported on generator_id to list evaluations across all generators under same project.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/generators/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2beta1/{+parent}/evaluations", +"response": { +"$ref": "GoogleCloudDialogflowV2beta1ListGeneratorEvaluationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +} +} +} } }, "knowledgeBases": { @@ -8602,7 +8726,7 @@ } } }, -"revision": "20250828", +"revision": "20250919", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -17966,6 +18090,23 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1EvaluationStatus": { +"description": "A common evalaution pipeline status.", +"id": "GoogleCloudDialogflowV2beta1EvaluationStatus", +"properties": { +"done": { +"description": "Output only. If the value is `false`, it means the evaluation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", +"readOnly": true, +"type": "boolean" +}, +"pipelineStatus": { +"$ref": "GoogleRpcStatus", +"description": "Output only. The error result of the evaluation in case of failure in evaluation pipeline.", +"readOnly": true +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1EventInput": { "description": "Events allow for matching intents by event name instead of the natural language input. For instance, input `` can trigger a personalized welcome response. The parameter `name` may be used by the agent in the response: `\"Hello #welcome_event.name! What can I do for you today?\"`.", "id": "GoogleCloudDialogflowV2beta1EventInput", @@ -18506,6 +18647,199 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1GeneratorEvaluation": { +"description": "Represents evaluation result of a generator.", +"id": "GoogleCloudDialogflowV2beta1GeneratorEvaluation", +"properties": { +"completeTime": { +"description": "Output only. Completion time of this generator evaluation.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"createTime": { +"description": "Output only. Creation time of this generator evaluation.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "Optional. The display name of the generator evaluation. At most 64 bytes long.", +"type": "string" +}, +"evaluationStatus": { +"$ref": "GoogleCloudDialogflowV2beta1EvaluationStatus", +"description": "Output only. The result status of the evaluation pipeline. Provides the status information including if the evaluation is still in progress, completed or failed with certain error and user actionable message.", +"readOnly": true +}, +"generatorEvaluationConfig": { +"$ref": "GoogleCloudDialogflowV2beta1GeneratorEvaluationConfig", +"description": "Required. The configuration of the evaluation task." +}, +"initialGenerator": { +"$ref": "GoogleCloudDialogflowV2beta1Generator", +"description": "Required. The initial generator that was used when creating this evaluation. This is a copy of the generator read from storage when creating the evaluation." +}, +"name": { +"description": "Output only. Identifier. The resource name of the evaluation. Format: `projects//locations//generators// evaluations/`", +"readOnly": true, +"type": "string" +}, +"summarizationMetrics": { +"$ref": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetrics", +"description": "Output only. Only available when the summarization generator is provided.", +"readOnly": true +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1GeneratorEvaluationConfig": { +"description": "Generator evaluation input config.", +"id": "GoogleCloudDialogflowV2beta1GeneratorEvaluationConfig", +"properties": { +"inputDataConfig": { +"$ref": "GoogleCloudDialogflowV2beta1GeneratorEvaluationConfigInputDataConfig", +"description": "Required. The config/source of input data." +}, +"outputGcsBucketPath": { +"description": "Required. The output Cloud Storage bucket path to store eval files, e.g. per_summary_accuracy_score report. This path is provided by customer and files stored in it are visible to customer, no internal data should be stored in this path.", +"type": "string" +}, +"summarizationConfig": { +"$ref": "GoogleCloudDialogflowV2beta1GeneratorEvaluationConfigSummarizationConfig", +"description": "Evaluation configs for summarization generator." +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1GeneratorEvaluationConfigAgentAssistInputDataConfig": { +"description": "The distinctive configs for Agent Assist conversations as the conversation source.", +"id": "GoogleCloudDialogflowV2beta1GeneratorEvaluationConfigAgentAssistInputDataConfig", +"properties": { +"endTime": { +"description": "Required. The end of the time range for conversations to be evaluated. Only conversations ended at or before this timestamp will be sampled.", +"format": "google-datetime", +"type": "string" +}, +"startTime": { +"description": "Required. The start of the time range for conversations to be evaluated. Only conversations created at or after this timestamp will be sampled.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1GeneratorEvaluationConfigDatasetInputDataConfig": { +"description": "The distinctive configs for dataset as the conversation source.", +"id": "GoogleCloudDialogflowV2beta1GeneratorEvaluationConfigDatasetInputDataConfig", +"properties": { +"dataset": { +"description": "Required. The identifier of the dataset to be evaluated. Format: `projects//locations//datasets/`.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1GeneratorEvaluationConfigInputDataConfig": { +"description": "Input data config details", +"id": "GoogleCloudDialogflowV2beta1GeneratorEvaluationConfigInputDataConfig", +"properties": { +"agentAssistInputDataConfig": { +"$ref": "GoogleCloudDialogflowV2beta1GeneratorEvaluationConfigAgentAssistInputDataConfig", +"description": "The distinctive configs for Agent Assist conversations as the conversation source." +}, +"datasetInputDataConfig": { +"$ref": "GoogleCloudDialogflowV2beta1GeneratorEvaluationConfigDatasetInputDataConfig", +"description": "The distinctive configs for dataset as the conversation source." +}, +"endTime": { +"deprecated": true, +"description": "Optional. The end timestamp to fetch conversation data.", +"format": "google-datetime", +"type": "string" +}, +"inputDataSourceType": { +"deprecated": true, +"description": "Required. The source type of input data.", +"enum": [ +"INPUT_DATA_SOURCE_TYPE_UNSPECIFIED", +"AGENT_ASSIST_CONVERSATIONS", +"INSIGHTS_CONVERSATIONS" +], +"enumDescriptions": [ +"Unspecified InputDataSourceType. Should not be used.", +"Fetch data from Agent Assist storage. If this source type is chosen, input_data_config.start_time and input_data_config.end_timestamp must be provided.", +"Fetch data from Insights storage. If this source type is chosen, input_data_config.start_time and input_data_config.end_timestamp must be provided." +], +"type": "string" +}, +"isSummaryGenerationAllowed": { +"deprecated": true, +"description": "Optional. Whether the summary generation is allowed when the pre-existing qualified summaries are insufficient to cover the sample size.", +"type": "boolean" +}, +"sampleSize": { +"description": "Optional. Desired number of conversation-summary pairs to be evaluated.", +"format": "int32", +"type": "integer" +}, +"startTime": { +"deprecated": true, +"description": "Optional. The start timestamp to fetch conversation data.", +"format": "google-datetime", +"type": "string" +}, +"summaryGenerationOption": { +"description": "Optional. Option to control whether summaries are generated during evaluation.", +"enum": [ +"SUMMARY_GENERATION_OPTION_UNSPECIFIED", +"ALWAYS_GENERATE", +"GENERATE_IF_MISSING", +"DO_NOT_GENERATE" +], +"enumDescriptions": [ +"Default option will not be used", +"Always Generate summary for all conversations.", +"Gnerate only missing summaries.", +"Do not generate new summaries. Only use existing summaries found." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1GeneratorEvaluationConfigSummarizationConfig": { +"description": "Evaluation configs for summarization generator.", +"id": "GoogleCloudDialogflowV2beta1GeneratorEvaluationConfigSummarizationConfig", +"properties": { +"accuracyEvaluationVersion": { +"deprecated": true, +"description": "Optional. Version for summarization accuracy. This will determine the prompt and model used at backend.", +"type": "string" +}, +"completenessEvaluationVersion": { +"deprecated": true, +"description": "Optional. Version for summarization completeness. This will determine the prompt and model used at backend.", +"type": "string" +}, +"enableAccuracyEvaluation": { +"deprecated": true, +"description": "Optional. Enable accuracy evaluation.", +"type": "boolean" +}, +"enableCompletenessEvaluation": { +"deprecated": true, +"description": "Optional. Enable completeness evaluation.", +"type": "boolean" +}, +"evaluatorVersion": { +"description": "Output only. Version for summarization evaluation.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1GeneratorSuggestion": { "description": "Suggestion generated using a Generator.", "id": "GoogleCloudDialogflowV2beta1GeneratorSuggestion", @@ -19104,7 +19438,7 @@ true ], "enumDescriptions": [ "Not specified.", -"Uncompressed 16-bit signed little-endian samples (Linear PCM). LINT: LEGACY_NAMES", +"Uncompressed 16-bit signed little-endian samples (Linear PCM).", "[`FLAC`](https://xiph.org/flac/documentation.html) (Free Lossless Audio Codec) is the recommended encoding because it is lossless (therefore recognition is not compromised) and requires only about half the bandwidth of `LINEAR16`. `FLAC` stream encoding supports 16-bit and 24-bit samples, however, not all fields in `STREAMINFO` are supported.", "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.", "Adaptive Multi-Rate Narrowband codec. `sample_rate_hertz` must be 8000.", @@ -20796,6 +21130,24 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1ListGeneratorEvaluationsResponse": { +"description": "Response of ListGeneratorEvaluations.", +"id": "GoogleCloudDialogflowV2beta1ListGeneratorEvaluationsResponse", +"properties": { +"generatorEvaluations": { +"description": "The list of evaluations to return.", +"items": { +"$ref": "GoogleCloudDialogflowV2beta1GeneratorEvaluation" +}, +"type": "array" +}, +"nextPageToken": { +"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1ListGeneratorsResponse": { "description": "Response of ListGenerators.", "id": "GoogleCloudDialogflowV2beta1ListGeneratorsResponse", @@ -21192,9 +21544,9 @@ true ], "enumDescriptions": [ "Not specified.", -"Uncompressed 16-bit signed little-endian samples (Linear PCM). Audio content returned as LINEAR16 also contains a WAV header. LINT: LEGACY_NAMES", +"Uncompressed 16-bit signed little-endian samples (Linear PCM). Audio content returned as LINEAR16 also contains a WAV header.", "MP3 audio at 32kbps.", -"MP3 audio at 64kbps. LINT: LEGACY_NAMES", +"MP3 audio at 64kbps.", "Opus encoded audio wrapped in an ogg container. The result will be a file which can be played natively on Android, and in browsers (at least Chrome and Firefox). The quality of the encoding is considerably higher than MP3 while using approximately the same bitrate.", "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.", "8-bit samples that compand 13-bit audio samples using G.711 PCMU/a-law." @@ -22182,7 +22534,7 @@ true ], "enumDescriptions": [ "Not specified.", -"Uncompressed 16-bit signed little-endian samples (Linear PCM). LINT: LEGACY_NAMES", +"Uncompressed 16-bit signed little-endian samples (Linear PCM).", "[`FLAC`](https://xiph.org/flac/documentation.html) (Free Lossless Audio Codec) is the recommended encoding because it is lossless (therefore recognition is not compromised) and requires only about half the bandwidth of `LINEAR16`. `FLAC` stream encoding supports 16-bit and 24-bit samples, however, not all fields in `STREAMINFO` are supported.", "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.", "Adaptive Multi-Rate Narrowband codec. `sample_rate_hertz` must be 8000.", @@ -22832,6 +23184,346 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1SummarizationEvaluationMetrics": { +"description": "Evaluation metrics for summarization generator.", +"id": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetrics", +"properties": { +"conversationDetails": { +"description": "Output only. List of conversation details.", +"items": { +"$ref": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsConversationDetail" +}, +"readOnly": true, +"type": "array" +}, +"overallMetrics": { +"description": "Output only. A list of aggregated(average) scores per metric section.", +"items": { +"$ref": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsOverallScoresByMetric" +}, +"readOnly": true, +"type": "array" +}, +"overallSectionTokens": { +"description": "Output only. Overall token per section. This is an aggregated(sum) result of input token of summary acorss all conversations that are selected for summarization evaluation.", +"items": { +"$ref": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsSectionToken" +}, +"readOnly": true, +"type": "array" +}, +"summarizationEvaluationMergedResultsUri": { +"description": "Output only. User bucket uri for merged evaluation score and aggregation score csv.", +"readOnly": true, +"type": "string" +}, +"summarizationEvaluationResults": { +"description": "Output only. A list of evaluation results per conversation(&summary), metric and section.", +"items": { +"$ref": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsSummarizationEvaluationResult" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsAccuracyDecomposition": { +"description": "Decomposition details for accuracy.", +"id": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsAccuracyDecomposition", +"properties": { +"accuracyReasoning": { +"description": "Output only. The accuracy reasoning of the breakdown point.", +"readOnly": true, +"type": "string" +}, +"isAccurate": { +"description": "Output only. Whether the breakdown point is accurate or not.", +"readOnly": true, +"type": "boolean" +}, +"point": { +"description": "Output only. The breakdown point of the summary.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsAdherenceDecomposition": { +"deprecated": true, +"description": "Decomposition details for adherence.", +"id": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsAdherenceDecomposition", +"properties": { +"adherenceReasoning": { +"description": "Output only. The adherence reasoning of the breakdown point.", +"readOnly": true, +"type": "string" +}, +"isAdherent": { +"description": "Output only. Whether the breakdown point is adherent or not.", +"readOnly": true, +"type": "boolean" +}, +"point": { +"description": "Output only. The breakdown point of the given instructions.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsAdherenceRubric": { +"description": "Rubric result of the adherence evaluation. A rubric is ued to determine if the summary adheres to all aspects of the given instructions.", +"id": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsAdherenceRubric", +"properties": { +"isAddressed": { +"description": "Output only. A boolean that indicates whether the rubric question is addressed or not.", +"readOnly": true, +"type": "boolean" +}, +"question": { +"description": "Output only. The question generated from instruction that used to evaluate summary.", +"readOnly": true, +"type": "string" +}, +"reasoning": { +"description": "Output only. The reasoning of the rubric question is addressed or not.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsCompletenessRubric": { +"description": "Rubric details of the completeness evaluation result.", +"id": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsCompletenessRubric", +"properties": { +"isAddressed": { +"description": "Output only. A boolean that indicates whether the rubric question is addressed or not.", +"readOnly": true, +"type": "boolean" +}, +"question": { +"description": "Output only. The question generated from instruction that used to evaluate summary.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsConversationDetail": { +"description": "Aggregated evaluation result on conversation level. This contains evaluation results of all the metrics and sections.", +"id": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsConversationDetail", +"properties": { +"messageEntries": { +"description": "Output only. Conversation transcript that used for summarization evaluation as a reference.", +"items": { +"$ref": "GoogleCloudDialogflowV2beta1MessageEntry" +}, +"readOnly": true, +"type": "array" +}, +"metricDetails": { +"description": "Output only. List of metric details.", +"items": { +"$ref": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsConversationDetailMetricDetail" +}, +"readOnly": true, +"type": "array" +}, +"sectionTokens": { +"description": "Output only. Conversation level token count per section. This is an aggregated(sum) result of input token of summary acorss all metrics for a single conversation.", +"items": { +"$ref": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsSectionToken" +}, +"readOnly": true, +"type": "array" +}, +"summarySections": { +"description": "Output only. Summary sections that used for summarization evaluation as a reference.", +"items": { +"$ref": "GoogleCloudDialogflowV2beta1SummarySuggestionSummarySection" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsConversationDetailMetricDetail": { +"description": "Aggregated result on metric level. This contains the evaluation results of all the sections.", +"id": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsConversationDetailMetricDetail", +"properties": { +"metric": { +"description": "Output only. Metrics name. e.g. accuracy, adherence, completeness.", +"readOnly": true, +"type": "string" +}, +"score": { +"description": "Output only. Aggregated(average) score on this metric across all sections.", +"format": "float", +"readOnly": true, +"type": "number" +}, +"sectionDetails": { +"description": "Output only. List of section details.", +"items": { +"$ref": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsConversationDetailMetricDetailSectionDetail" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsConversationDetailMetricDetailSectionDetail": { +"description": "Section level result.", +"id": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsConversationDetailMetricDetailSectionDetail", +"properties": { +"evaluationResults": { +"description": "Output only. List of evaluation result. The list only contains one kind of the evaluation result.", +"items": { +"$ref": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsEvaluationResult" +}, +"readOnly": true, +"type": "array" +}, +"score": { +"description": "Output only. Aggregated(average) score on this section across all evaluation results. Either decompositions or rubrics.", +"format": "float", +"readOnly": true, +"type": "number" +}, +"section": { +"description": "Output only. The name of the summary instruction.", +"readOnly": true, +"type": "string" +}, +"sectionSummary": { +"description": "Output only. Summary for this section", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsDecomposition": { +"deprecated": true, +"description": "Decomposition details", +"id": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsDecomposition", +"properties": { +"accuracyDecomposition": { +"$ref": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsAccuracyDecomposition", +"description": "only available for accuracy metric." +}, +"adherenceDecomposition": { +"$ref": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsAdherenceDecomposition", +"description": "only available for adherence metric." +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsEvaluationResult": { +"description": "Evaluation result that contains one of accuracy, adherence or completeness evaluation result.", +"id": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsEvaluationResult", +"properties": { +"accuracyDecomposition": { +"$ref": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsAccuracyDecomposition", +"description": "Only available for accuracy metric." +}, +"adherenceRubric": { +"$ref": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsAdherenceRubric", +"description": "Only available for adherence metric." +}, +"completenessRubric": { +"$ref": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsCompletenessRubric", +"description": "Only available for completeness metric." +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsOverallScoresByMetric": { +"description": "Overall performance per metric. This is the aggregated score for each metric across all conversations that are selected for summarization evaluation.", +"id": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsOverallScoresByMetric", +"properties": { +"metric": { +"description": "Output only. Metric name. e.g. accuracy, adherence, completeness.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsSectionToken": { +"description": "A pair of section name and input token count of the input summary section.", +"id": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsSectionToken", +"properties": { +"section": { +"description": "Output only. The name of the summary instruction.", +"readOnly": true, +"type": "string" +}, +"tokenCount": { +"description": "Output only. Token count.", +"format": "int64", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsSummarizationEvaluationResult": { +"description": "Evaluation result per conversation(&summary), metric and section.", +"id": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsSummarizationEvaluationResult", +"properties": { +"decompositions": { +"deprecated": true, +"description": "Output only. List of decompostion details", +"items": { +"$ref": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsDecomposition" +}, +"readOnly": true, +"type": "array" +}, +"evaluationResults": { +"description": "Output only. List of evaluation results.", +"items": { +"$ref": "GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsEvaluationResult" +}, +"readOnly": true, +"type": "array" +}, +"metric": { +"description": "Output only. metric name, e.g. accuracy, completeness, adherence, etc.", +"readOnly": true, +"type": "string" +}, +"score": { +"description": "Output only. score calculated from decompositions", +"format": "float", +"readOnly": true, +"type": "number" +}, +"section": { +"description": "Output only. section/task name, e.g. action, situation, etc", +"readOnly": true, +"type": "string" +}, +"sectionSummary": { +"description": "Output only. Summary of this section", +"readOnly": true, +"type": "string" +}, +"sessionId": { +"deprecated": true, +"description": "Output only. conversation session id", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1SummarizationSection": { "description": "Represents the section of summarization.", "id": "GoogleCloudDialogflowV2beta1SummarizationSection", @@ -23046,9 +23738,9 @@ true ], "enumDescriptions": [ "Not specified.", -"Uncompressed 16-bit signed little-endian samples (Linear PCM). Audio content returned as LINEAR16 also contains a WAV header. LINT: LEGACY_NAMES", +"Uncompressed 16-bit signed little-endian samples (Linear PCM). Audio content returned as LINEAR16 also contains a WAV header.", "MP3 audio at 32kbps.", -"MP3 audio at 64kbps. LINT: LEGACY_NAMES", +"MP3 audio at 64kbps.", "Opus encoded audio wrapped in an ogg container. The result will be a file which can be played natively on Android, and in browsers (at least Chrome and Firefox). The quality of the encoding is considerably higher than MP3 while using approximately the same bitrate.", "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.", "8-bit samples that compand 13-bit audio samples using G.711 PCMU/a-law." diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v3.json b/googleapiclient/discovery_cache/documents/dialogflow.v3.json index e699c525e40..67e9c0fb5c4 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. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", +"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" @@ -5309,7 +5309,7 @@ } } }, -"revision": "20250902", +"revision": "20250919", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3Action": { diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json b/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json index c0c49571610..d2a81e294f1 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. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", +"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" @@ -5436,7 +5436,7 @@ } } }, -"revision": "20250828", +"revision": "20250919", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { From 74265e6935cb31ae8be52e93b87bcc87b458b4fe Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 30 Sep 2025 07:09:35 +0000 Subject: [PATCH 17/42] feat(discoveryengine): update the api #### discoveryengine:v1 The following keys were added: - resources.projects.resources.locations.resources.collections.resources.dataConnector.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.models.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.schemas.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.targetSites.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - resources.projects.resources.locations.resources.collections.resources.engines.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - resources.projects.resources.locations.resources.collections.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - resources.projects.resources.locations.resources.dataStores.resources.models.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - resources.projects.resources.locations.resources.dataStores.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - resources.projects.resources.locations.resources.identityMappingStores.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.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1ActionConfig.properties.jsonActionParams.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1BAPConfig.properties.enabledActions (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig.properties.jsonAuthParams.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig.properties.jsonAuthParams.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1DataStore.properties.configurableBillingApproach.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1SearchRequest.properties.naturalLanguageQueryUnderstandingSpec.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1SearchRequestNaturalLanguageQueryUnderstandingSpec (Total Keys: 8) - schemas.GoogleCloudDiscoveryengineV1alphaActionConfig.properties.jsonActionParams.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaBAPConfig.properties.enabledActions (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig.properties.jsonAuthParams.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig.properties.jsonAuthParams.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaDataStore.properties.configurableBillingApproach.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaDataStore.properties.configurableBillingApproach.type (Total Keys: 1) - schemas.GoogleLongrunningListOperationsResponse.properties.unreachable (Total Keys: 2) #### discoveryengine:v1alpha The following keys were added: - resources.projects.resources.locations.resources.collections.resources.dataConnector.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.methods.get (Total Keys: 13) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.methods.list (Total Keys: 13) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.models.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.schemas.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.targetSites.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - resources.projects.resources.locations.resources.collections.resources.engines.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - resources.projects.resources.locations.resources.collections.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - resources.projects.resources.locations.resources.dataStores.resources.branches.methods.get (Total Keys: 13) - resources.projects.resources.locations.resources.dataStores.resources.branches.methods.list (Total Keys: 13) - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - resources.projects.resources.locations.resources.dataStores.resources.models.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - resources.projects.resources.locations.resources.dataStores.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - resources.projects.resources.locations.resources.identityMappingStores.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.userStores.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - resources.projects.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1ActionConfig.properties.jsonActionParams.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1BAPConfig.properties.enabledActions (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig.properties.jsonAuthParams.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig.properties.jsonAuthParams.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1DataStore.properties.configurableBillingApproach.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaActionConfig.properties.jsonActionParams.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaAssistAnswerReply.properties.replyId (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaBAPConfig.properties.enabledActions (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaBranch (Total Keys: 17) - schemas.GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig.properties.jsonAuthParams.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig.properties.jsonAuthParams.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaDataStore.properties.configurableBillingApproach.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaListBranchesResponse (Total Keys: 4) - schemas.GoogleCloudDiscoveryengineV1betaDataStore.properties.configurableBillingApproach.type (Total Keys: 1) - schemas.GoogleLongrunningListOperationsResponse.properties.unreachable (Total Keys: 2) #### discoveryengine:v1beta The following keys were added: - resources.projects.resources.locations.resources.collections.resources.dataConnector.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.models.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.schemas.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.targetSites.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - resources.projects.resources.locations.resources.collections.resources.engines.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - resources.projects.resources.locations.resources.collections.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - resources.projects.resources.locations.resources.dataStores.resources.models.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - resources.projects.resources.locations.resources.dataStores.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - resources.projects.resources.locations.resources.identityMappingStores.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.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1ActionConfig.properties.jsonActionParams.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1BAPConfig.properties.enabledActions (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig.properties.jsonAuthParams.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig.properties.jsonAuthParams.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1DataStore.properties.configurableBillingApproach.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaActionConfig.properties.jsonActionParams.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaBAPConfig.properties.enabledActions (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig.properties.jsonAuthParams.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig.properties.jsonAuthParams.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaDataStore.properties.configurableBillingApproach.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaDataStore.properties.configurableBillingApproach.type (Total Keys: 1) - schemas.GoogleLongrunningListOperationsResponse.properties.unreachable (Total Keys: 2) --- ....collections.dataConnector.operations.html | 8 +- ...ctions.dataStores.branches.operations.html | 8 +- ...ects.locations.collections.dataStores.html | 5 + ...lections.dataStores.models.operations.html | 8 +- ...ons.collections.dataStores.operations.html | 8 +- ...ections.dataStores.schemas.operations.html | 8 +- ...collections.dataStores.servingConfigs.html | 22 +- ...ataStores.siteSearchEngine.operations.html | 8 +- ...teSearchEngine.targetSites.operations.html | 8 +- ...ons.collections.dataStores.userEvents.html | 6 +- ...rojects.locations.collections.engines.html | 10 +- ...ations.collections.engines.operations.html | 8 +- ...ns.collections.engines.servingConfigs.html | 22 +- ...ine_v1.projects.locations.collections.html | 30 +- ...ects.locations.collections.operations.html | 8 +- ...ations.dataStores.branches.operations.html | 8 +- ...gine_v1.projects.locations.dataStores.html | 5 + ...ocations.dataStores.models.operations.html | 8 +- ...jects.locations.dataStores.operations.html | 8 +- ...s.locations.dataStores.servingConfigs.html | 22 +- ...jects.locations.dataStores.userEvents.html | 6 +- ...discoveryengine_v1.projects.locations.html | 20 +- ...ions.identityMappingStores.operations.html | 8 +- ...gine_v1.projects.locations.operations.html | 8 +- ...gine_v1.projects.locations.userEvents.html | 6 +- ...iscoveryengine_v1.projects.operations.html | 8 +- ...s.locations.collections.dataConnector.html | 4 +- ....collections.dataConnector.operations.html | 8 +- ...tions.collections.dataStores.branches.html | 74 +++ ...ctions.dataStores.branches.operations.html | 8 +- ...ects.locations.collections.dataStores.html | 5 + ...lections.dataStores.models.operations.html | 8 +- ...ons.collections.dataStores.operations.html | 8 +- ...ections.dataStores.schemas.operations.html | 8 +- ...collections.dataStores.servingConfigs.html | 10 +- ...ataStores.siteSearchEngine.operations.html | 8 +- ...teSearchEngine.targetSites.operations.html | 8 +- ...ons.collections.dataStores.userEvents.html | 6 +- ....collections.dataStores.widgetConfigs.html | 2 +- ...ations.collections.engines.assistants.html | 1 + ...rojects.locations.collections.engines.html | 14 +- ...ations.collections.engines.operations.html | 8 +- ...ns.collections.engines.servingConfigs.html | 10 +- ...ons.collections.engines.widgetConfigs.html | 2 +- ...1alpha.projects.locations.collections.html | 60 ++- ...ects.locations.collections.operations.html | 8 +- ...rojects.locations.dataStores.branches.html | 74 +++ ...ations.dataStores.branches.operations.html | 8 +- ...v1alpha.projects.locations.dataStores.html | 5 + ...ocations.dataStores.models.operations.html | 8 +- ...jects.locations.dataStores.operations.html | 8 +- ...s.locations.dataStores.servingConfigs.html | 10 +- ...jects.locations.dataStores.userEvents.html | 6 +- ...ts.locations.dataStores.widgetConfigs.html | 2 +- ...1alpha.projects.locations.evaluations.html | 12 +- ...veryengine_v1alpha.projects.locations.html | 20 +- ...ions.identityMappingStores.operations.html | 8 +- ....projects.locations.notebooks.sources.html | 6 +- ...v1alpha.projects.locations.operations.html | 8 +- ...v1alpha.projects.locations.userEvents.html | 6 +- ...jects.locations.userStores.operations.html | 8 +- ...eryengine_v1alpha.projects.operations.html | 8 +- ....collections.dataConnector.operations.html | 8 +- ...ctions.dataStores.branches.operations.html | 8 +- ...ects.locations.collections.dataStores.html | 5 + ...lections.dataStores.models.operations.html | 8 +- ...ons.collections.dataStores.operations.html | 8 +- ...ections.dataStores.schemas.operations.html | 8 +- ...collections.dataStores.servingConfigs.html | 10 +- ...ataStores.siteSearchEngine.operations.html | 8 +- ...teSearchEngine.targetSites.operations.html | 8 +- ...ons.collections.dataStores.userEvents.html | 6 +- ...rojects.locations.collections.engines.html | 14 +- ...ations.collections.engines.operations.html | 8 +- ...ns.collections.engines.servingConfigs.html | 10 +- ...ects.locations.collections.operations.html | 8 +- ...ations.dataStores.branches.operations.html | 8 +- ..._v1beta.projects.locations.dataStores.html | 5 + ...ocations.dataStores.models.operations.html | 8 +- ...jects.locations.dataStores.operations.html | 8 +- ...s.locations.dataStores.servingConfigs.html | 10 +- ...jects.locations.dataStores.userEvents.html | 6 +- ...v1beta.projects.locations.evaluations.html | 12 +- ...ions.identityMappingStores.operations.html | 8 +- ..._v1beta.projects.locations.operations.html | 8 +- ..._v1beta.projects.locations.userEvents.html | 6 +- ...veryengine_v1beta.projects.operations.html | 8 +- .../documents/discoveryengine.v1.json | 263 +++++++++- .../documents/discoveryengine.v1alpha.json | 451 +++++++++++++++++- .../documents/discoveryengine.v1beta.json | 210 +++++++- 90 files changed, 1574 insertions(+), 285 deletions(-) diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataConnector.operations.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataConnector.operations.html index 4f109fbee15..15483c902ec 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataConnector.operations.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataConnector.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/discoveryengine_v1.projects.locations.collections.dataStores.branches.operations.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.branches.operations.html index 28641ebdc8c..1fd9ed56c59 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.branches.operations.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.branches.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/discoveryengine_v1.projects.locations.collections.dataStores.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html index cb231f0ab9d..e9829bdedca 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html @@ -248,6 +248,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. "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. @@ -458,6 +459,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. "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. @@ -624,6 +626,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. "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. @@ -778,6 +781,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. "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. @@ -914,6 +918,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. "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.models.operations.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.models.operations.html index ba9b33e0c2b..efadf7e37f3 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.models.operations.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.models.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/discoveryengine_v1.projects.locations.collections.dataStores.operations.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.operations.html index 60c85cfc08b..588d48f08aa 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.operations.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.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/discoveryengine_v1.projects.locations.collections.dataStores.schemas.operations.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.schemas.operations.html index d88e77ef6c2..0d03df71e37 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.schemas.operations.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.schemas.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/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html index f541bb9fd73..52d2e6aefad 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html @@ -838,7 +838,7 @@

Method Details

], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. - "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. + "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. "mediaInfo": { # Media-specific user event information. # Media-specific info. "mediaProgressDuration": "A String", # The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be set to 90. @@ -1127,6 +1127,16 @@

Method Details

"imageBytes": "A String", # Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP. }, "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. + "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. + "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored. + "A String", + ], + "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED. + "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. + "A String", + ], + }, "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold. "oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10. "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. @@ -1516,6 +1526,16 @@

Method Details

"imageBytes": "A String", # Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP. }, "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. + "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. + "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored. + "A String", + ], + "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED. + "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. + "A String", + ], + }, "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold. "oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10. "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.siteSearchEngine.operations.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.siteSearchEngine.operations.html index 7ba43464230..8a15337c516 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.siteSearchEngine.operations.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.siteSearchEngine.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/discoveryengine_v1.projects.locations.collections.dataStores.siteSearchEngine.targetSites.operations.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.siteSearchEngine.targetSites.operations.html index f4b34fef763..c9545b5f5e1 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.siteSearchEngine.targetSites.operations.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.siteSearchEngine.targetSites.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/discoveryengine_v1.projects.locations.collections.dataStores.userEvents.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.userEvents.html index 0303a5efd42..ac0d82f698f 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.userEvents.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.userEvents.html @@ -190,7 +190,7 @@

Method Details

], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. - "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. + "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. "mediaInfo": { # Media-specific user event information. # Media-specific info. "mediaProgressDuration": "A String", # The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be set to 90. @@ -388,7 +388,7 @@

Method Details

], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. - "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. + "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. "mediaInfo": { # Media-specific user event information. # Media-specific info. "mediaProgressDuration": "A String", # The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be set to 90. @@ -511,7 +511,7 @@

Method Details

], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. - "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. + "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. "mediaInfo": { # Media-specific user event information. # Media-specific info. "mediaProgressDuration": "A String", # The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be set to 90. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html index 4fc6638dffe..86333e9caa4 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html @@ -170,7 +170,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation` * `disable-onedrive-upload` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -306,7 +306,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation` * `disable-onedrive-upload` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -383,7 +383,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation` * `disable-onedrive-upload` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -467,7 +467,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation` * `disable-onedrive-upload` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -533,7 +533,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation` * `disable-onedrive-upload` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.operations.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.operations.html index 75049a5ea9d..01524cee3f9 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.operations.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.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/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html index 95d031e6c48..a7dc9b7b7d6 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html @@ -838,7 +838,7 @@

Method Details

], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. - "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. + "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. "mediaInfo": { # Media-specific user event information. # Media-specific info. "mediaProgressDuration": "A String", # The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be set to 90. @@ -1127,6 +1127,16 @@

Method Details

"imageBytes": "A String", # Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP. }, "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. + "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. + "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored. + "A String", + ], + "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED. + "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. + "A String", + ], + }, "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold. "oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10. "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. @@ -1516,6 +1526,16 @@

Method Details

"imageBytes": "A String", # Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP. }, "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. + "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. + "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored. + "A String", + ], + "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED. + "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. + "A String", + ], + }, "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold. "oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10. "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.html index dc8009f14ba..993470d0f21 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.html @@ -164,10 +164,11 @@

Method Details

{ # Manages the connection to external data sources for all data stores grouped under a Collection. It's a singleton resource of Collection. The initialization is only supported through DataConnectorService.SetUpDataConnector method, which will create a new Collection and initialize its DataConnector. "aclEnabled": True or False, # Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors. "actionConfig": { # Informations to support actions on the connector. # Optional. Action configurations to make the connector support actions. - "actionParams": { # Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client ID for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server. + "actionParams": { # Optional. Action parameters in structured json format. "a_key": "", # Properties of the object. }, "isActionConfigured": True or False, # Output only. The connector contains the necessary parameters and is configured to support actions. + "jsonActionParams": "A String", # Optional. Action parameters in json string format. "serviceName": "A String", # Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled. "useStaticSecrets": True or False, # Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored. }, @@ -185,6 +186,9 @@

Method Details

], "autoRunDisabled": True or False, # Optional. Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. Update: with the introduction of incremental_sync_disabled, auto_run_disabled is used to pause/disable only full syncs "bapConfig": { # The configuration for the BAP connector. # Optional. The configuration for establishing a BAP connection. + "enabledActions": [ # Optional. The actions enabled on the associated BAP connection. + "A String", + ], "supportedConnectorModes": [ # Required. The supported connector modes for the associated BAP connection. "A String", ], @@ -221,6 +225,7 @@

Method Details

"authParams": { # Optional. Any authentication parameters specific to EUA connectors. "a_key": "", # Properties of the object. }, + "jsonAuthParams": "A String", # Optional. Any authentication parameters specific to EUA connectors in json string format. "tenant": { # Tenant information for a connector source. This includes some of the same information stored in the Credential message, but is limited to only what is needed to provide a list of accessible tenants to the user. # Optional. The tenant project the connector is connected to. "displayName": "A String", # Optional display name for the tenant, e.g. "My Slack Team". "id": "A String", # The tenant's instance ID. Examples: Jira ("8594f221-9797-5f78-1fa4-485e198d7cd0"), Slack ("T123456"). @@ -266,9 +271,10 @@

Method Details

"additionalParams": { # Optional. Any additional parameters needed for FEDERATED. "a_key": "", # Properties of the object. }, - "authParams": { # Optional. Any authentication parameters specific to FEDERATED. + "authParams": { # Optional. Any authentication parameters specific to FEDERATED connectors. "a_key": "", # Properties of the object. }, + "jsonAuthParams": "A String", # Optional. Any authentication parameters specific to FEDERATED connectors in json string format. }, "hybridIngestionDisabled": True or False, # Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored. "identityRefreshInterval": "A String", # The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days. @@ -357,10 +363,11 @@

Method Details

{ # Manages the connection to external data sources for all data stores grouped under a Collection. It's a singleton resource of Collection. The initialization is only supported through DataConnectorService.SetUpDataConnector method, which will create a new Collection and initialize its DataConnector. "aclEnabled": True or False, # Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors. "actionConfig": { # Informations to support actions on the connector. # Optional. Action configurations to make the connector support actions. - "actionParams": { # Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client ID for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server. + "actionParams": { # Optional. Action parameters in structured json format. "a_key": "", # Properties of the object. }, "isActionConfigured": True or False, # Output only. The connector contains the necessary parameters and is configured to support actions. + "jsonActionParams": "A String", # Optional. Action parameters in json string format. "serviceName": "A String", # Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled. "useStaticSecrets": True or False, # Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored. }, @@ -378,6 +385,9 @@

Method Details

], "autoRunDisabled": True or False, # Optional. Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. Update: with the introduction of incremental_sync_disabled, auto_run_disabled is used to pause/disable only full syncs "bapConfig": { # The configuration for the BAP connector. # Optional. The configuration for establishing a BAP connection. + "enabledActions": [ # Optional. The actions enabled on the associated BAP connection. + "A String", + ], "supportedConnectorModes": [ # Required. The supported connector modes for the associated BAP connection. "A String", ], @@ -414,6 +424,7 @@

Method Details

"authParams": { # Optional. Any authentication parameters specific to EUA connectors. "a_key": "", # Properties of the object. }, + "jsonAuthParams": "A String", # Optional. Any authentication parameters specific to EUA connectors in json string format. "tenant": { # Tenant information for a connector source. This includes some of the same information stored in the Credential message, but is limited to only what is needed to provide a list of accessible tenants to the user. # Optional. The tenant project the connector is connected to. "displayName": "A String", # Optional display name for the tenant, e.g. "My Slack Team". "id": "A String", # The tenant's instance ID. Examples: Jira ("8594f221-9797-5f78-1fa4-485e198d7cd0"), Slack ("T123456"). @@ -459,9 +470,10 @@

Method Details

"additionalParams": { # Optional. Any additional parameters needed for FEDERATED. "a_key": "", # Properties of the object. }, - "authParams": { # Optional. Any authentication parameters specific to FEDERATED. + "authParams": { # Optional. Any authentication parameters specific to FEDERATED connectors. "a_key": "", # Properties of the object. }, + "jsonAuthParams": "A String", # Optional. Any authentication parameters specific to FEDERATED connectors in json string format. }, "hybridIngestionDisabled": True or False, # Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored. "identityRefreshInterval": "A String", # The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days. @@ -549,10 +561,11 @@

Method Details

{ # Manages the connection to external data sources for all data stores grouped under a Collection. It's a singleton resource of Collection. The initialization is only supported through DataConnectorService.SetUpDataConnector method, which will create a new Collection and initialize its DataConnector. "aclEnabled": True or False, # Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors. "actionConfig": { # Informations to support actions on the connector. # Optional. Action configurations to make the connector support actions. - "actionParams": { # Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client ID for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server. + "actionParams": { # Optional. Action parameters in structured json format. "a_key": "", # Properties of the object. }, "isActionConfigured": True or False, # Output only. The connector contains the necessary parameters and is configured to support actions. + "jsonActionParams": "A String", # Optional. Action parameters in json string format. "serviceName": "A String", # Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled. "useStaticSecrets": True or False, # Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored. }, @@ -570,6 +583,9 @@

Method Details

], "autoRunDisabled": True or False, # Optional. Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. Update: with the introduction of incremental_sync_disabled, auto_run_disabled is used to pause/disable only full syncs "bapConfig": { # The configuration for the BAP connector. # Optional. The configuration for establishing a BAP connection. + "enabledActions": [ # Optional. The actions enabled on the associated BAP connection. + "A String", + ], "supportedConnectorModes": [ # Required. The supported connector modes for the associated BAP connection. "A String", ], @@ -606,6 +622,7 @@

Method Details

"authParams": { # Optional. Any authentication parameters specific to EUA connectors. "a_key": "", # Properties of the object. }, + "jsonAuthParams": "A String", # Optional. Any authentication parameters specific to EUA connectors in json string format. "tenant": { # Tenant information for a connector source. This includes some of the same information stored in the Credential message, but is limited to only what is needed to provide a list of accessible tenants to the user. # Optional. The tenant project the connector is connected to. "displayName": "A String", # Optional display name for the tenant, e.g. "My Slack Team". "id": "A String", # The tenant's instance ID. Examples: Jira ("8594f221-9797-5f78-1fa4-485e198d7cd0"), Slack ("T123456"). @@ -651,9 +668,10 @@

Method Details

"additionalParams": { # Optional. Any additional parameters needed for FEDERATED. "a_key": "", # Properties of the object. }, - "authParams": { # Optional. Any authentication parameters specific to FEDERATED. + "authParams": { # Optional. Any authentication parameters specific to FEDERATED connectors. "a_key": "", # Properties of the object. }, + "jsonAuthParams": "A String", # Optional. Any authentication parameters specific to FEDERATED connectors in json string format. }, "hybridIngestionDisabled": True or False, # Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored. "identityRefreshInterval": "A String", # The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.operations.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.operations.html index 230b370dbdd..118eecba98f 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.operations.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.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/discoveryengine_v1.projects.locations.dataStores.branches.operations.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.branches.operations.html index 4ebdeca5ebf..8c12ab3e187 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.branches.operations.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.branches.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/discoveryengine_v1.projects.locations.dataStores.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html index 34fc81369c6..da13e93ed2e 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html @@ -240,6 +240,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. "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. @@ -450,6 +451,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. "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. @@ -616,6 +618,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. "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. @@ -770,6 +773,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. "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. @@ -906,6 +910,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. "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.models.operations.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.models.operations.html index 7ffea303a04..8478329455c 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.models.operations.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.models.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/discoveryengine_v1.projects.locations.dataStores.operations.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.operations.html index 72a17406c69..9f673c84da1 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.operations.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.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/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html index 01525eeabba..0e544cdd424 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html @@ -838,7 +838,7 @@

Method Details

], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. - "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. + "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. "mediaInfo": { # Media-specific user event information. # Media-specific info. "mediaProgressDuration": "A String", # The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be set to 90. @@ -1127,6 +1127,16 @@

Method Details

"imageBytes": "A String", # Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP. }, "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. + "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. + "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored. + "A String", + ], + "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED. + "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. + "A String", + ], + }, "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold. "oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10. "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. @@ -1516,6 +1526,16 @@

Method Details

"imageBytes": "A String", # Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP. }, "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. + "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. + "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored. + "A String", + ], + "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED. + "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. + "A String", + ], + }, "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold. "oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10. "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.userEvents.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.userEvents.html index c13e5dce520..83626d25a5e 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.userEvents.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.userEvents.html @@ -190,7 +190,7 @@

Method Details

], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. - "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. + "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. "mediaInfo": { # Media-specific user event information. # Media-specific info. "mediaProgressDuration": "A String", # The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be set to 90. @@ -388,7 +388,7 @@

Method Details

], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. - "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. + "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. "mediaInfo": { # Media-specific user event information. # Media-specific info. "mediaProgressDuration": "A String", # The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be set to 90. @@ -511,7 +511,7 @@

Method Details

], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. - "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. + "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. "mediaInfo": { # Media-specific user event information. # Media-specific info. "mediaProgressDuration": "A String", # The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be set to 90. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.html b/docs/dyn/discoveryengine_v1.projects.locations.html index 7466d4d389e..830be407523 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.html @@ -221,10 +221,11 @@

Method Details

"dataConnector": { # Manages the connection to external data sources for all data stores grouped under a Collection. It's a singleton resource of Collection. The initialization is only supported through DataConnectorService.SetUpDataConnector method, which will create a new Collection and initialize its DataConnector. # Required. The DataConnector to initialize in the newly created Collection. "aclEnabled": True or False, # Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors. "actionConfig": { # Informations to support actions on the connector. # Optional. Action configurations to make the connector support actions. - "actionParams": { # Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client ID for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server. + "actionParams": { # Optional. Action parameters in structured json format. "a_key": "", # Properties of the object. }, "isActionConfigured": True or False, # Output only. The connector contains the necessary parameters and is configured to support actions. + "jsonActionParams": "A String", # Optional. Action parameters in json string format. "serviceName": "A String", # Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled. "useStaticSecrets": True or False, # Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored. }, @@ -242,6 +243,9 @@

Method Details

], "autoRunDisabled": True or False, # Optional. Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. Update: with the introduction of incremental_sync_disabled, auto_run_disabled is used to pause/disable only full syncs "bapConfig": { # The configuration for the BAP connector. # Optional. The configuration for establishing a BAP connection. + "enabledActions": [ # Optional. The actions enabled on the associated BAP connection. + "A String", + ], "supportedConnectorModes": [ # Required. The supported connector modes for the associated BAP connection. "A String", ], @@ -278,6 +282,7 @@

Method Details

"authParams": { # Optional. Any authentication parameters specific to EUA connectors. "a_key": "", # Properties of the object. }, + "jsonAuthParams": "A String", # Optional. Any authentication parameters specific to EUA connectors in json string format. "tenant": { # Tenant information for a connector source. This includes some of the same information stored in the Credential message, but is limited to only what is needed to provide a list of accessible tenants to the user. # Optional. The tenant project the connector is connected to. "displayName": "A String", # Optional display name for the tenant, e.g. "My Slack Team". "id": "A String", # The tenant's instance ID. Examples: Jira ("8594f221-9797-5f78-1fa4-485e198d7cd0"), Slack ("T123456"). @@ -323,9 +328,10 @@

Method Details

"additionalParams": { # Optional. Any additional parameters needed for FEDERATED. "a_key": "", # Properties of the object. }, - "authParams": { # Optional. Any authentication parameters specific to FEDERATED. + "authParams": { # Optional. Any authentication parameters specific to FEDERATED connectors. "a_key": "", # Properties of the object. }, + "jsonAuthParams": "A String", # Optional. Any authentication parameters specific to FEDERATED connectors in json string format. }, "hybridIngestionDisabled": True or False, # Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored. "identityRefreshInterval": "A String", # The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days. @@ -443,10 +449,11 @@

Method Details

{ # Manages the connection to external data sources for all data stores grouped under a Collection. It's a singleton resource of Collection. The initialization is only supported through DataConnectorService.SetUpDataConnector method, which will create a new Collection and initialize its DataConnector. "aclEnabled": True or False, # Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors. "actionConfig": { # Informations to support actions on the connector. # Optional. Action configurations to make the connector support actions. - "actionParams": { # Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client ID for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server. + "actionParams": { # Optional. Action parameters in structured json format. "a_key": "", # Properties of the object. }, "isActionConfigured": True or False, # Output only. The connector contains the necessary parameters and is configured to support actions. + "jsonActionParams": "A String", # Optional. Action parameters in json string format. "serviceName": "A String", # Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled. "useStaticSecrets": True or False, # Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored. }, @@ -464,6 +471,9 @@

Method Details

], "autoRunDisabled": True or False, # Optional. Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. Update: with the introduction of incremental_sync_disabled, auto_run_disabled is used to pause/disable only full syncs "bapConfig": { # The configuration for the BAP connector. # Optional. The configuration for establishing a BAP connection. + "enabledActions": [ # Optional. The actions enabled on the associated BAP connection. + "A String", + ], "supportedConnectorModes": [ # Required. The supported connector modes for the associated BAP connection. "A String", ], @@ -500,6 +510,7 @@

Method Details

"authParams": { # Optional. Any authentication parameters specific to EUA connectors. "a_key": "", # Properties of the object. }, + "jsonAuthParams": "A String", # Optional. Any authentication parameters specific to EUA connectors in json string format. "tenant": { # Tenant information for a connector source. This includes some of the same information stored in the Credential message, but is limited to only what is needed to provide a list of accessible tenants to the user. # Optional. The tenant project the connector is connected to. "displayName": "A String", # Optional display name for the tenant, e.g. "My Slack Team". "id": "A String", # The tenant's instance ID. Examples: Jira ("8594f221-9797-5f78-1fa4-485e198d7cd0"), Slack ("T123456"). @@ -545,9 +556,10 @@

Method Details

"additionalParams": { # Optional. Any additional parameters needed for FEDERATED. "a_key": "", # Properties of the object. }, - "authParams": { # Optional. Any authentication parameters specific to FEDERATED. + "authParams": { # Optional. Any authentication parameters specific to FEDERATED connectors. "a_key": "", # Properties of the object. }, + "jsonAuthParams": "A String", # Optional. Any authentication parameters specific to FEDERATED connectors in json string format. }, "hybridIngestionDisabled": True or False, # Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored. "identityRefreshInterval": "A String", # The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.identityMappingStores.operations.html b/docs/dyn/discoveryengine_v1.projects.locations.identityMappingStores.operations.html index 6b2ea660cf2..025738f5e41 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.identityMappingStores.operations.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.identityMappingStores.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/discoveryengine_v1.projects.locations.operations.html b/docs/dyn/discoveryengine_v1.projects.locations.operations.html index c4f82c07096..c06a1a5d828 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.operations.html +++ b/docs/dyn/discoveryengine_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/discoveryengine_v1.projects.locations.userEvents.html b/docs/dyn/discoveryengine_v1.projects.locations.userEvents.html index 2142973e8ff..df8cc0b4555 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.userEvents.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.userEvents.html @@ -187,7 +187,7 @@

Method Details

], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. - "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. + "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. "mediaInfo": { # Media-specific user event information. # Media-specific info. "mediaProgressDuration": "A String", # The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be set to 90. @@ -342,7 +342,7 @@

Method Details

], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. - "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. + "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. "mediaInfo": { # Media-specific user event information. # Media-specific info. "mediaProgressDuration": "A String", # The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be set to 90. @@ -465,7 +465,7 @@

Method Details

], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. - "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. + "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. "mediaInfo": { # Media-specific user event information. # Media-specific info. "mediaProgressDuration": "A String", # The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be set to 90. diff --git a/docs/dyn/discoveryengine_v1.projects.operations.html b/docs/dyn/discoveryengine_v1.projects.operations.html index da5cb1b30a9..35b4c177d5c 100644 --- a/docs/dyn/discoveryengine_v1.projects.operations.html +++ b/docs/dyn/discoveryengine_v1.projects.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/discoveryengine_v1alpha.projects.locations.collections.dataConnector.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataConnector.html index 91d8b4e0331..d84b6bcc9d3 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataConnector.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataConnector.html @@ -86,7 +86,7 @@

Instance Methods

acquireAccessToken(name, body=None, x__xgafv=None)

-

Uses the per-user refresh token minted with AcquireAndStoreRefreshToken to generate and return a new access token and its details. Takes the access token from cache if available. Rotates the stored refresh token if needed. Uses the end user identity to return the user specific access token. Does *not* return the credentials configured by the administrator. Used by Agentspace action execution and Agentspace UI.

+

Uses the per-user refresh token minted with AcquireAndStoreRefreshToken to generate and return a new access token and its details. Takes the access token from cache if available. Rotates the stored refresh token if needed. Uses the end user identity to return the user specific access token. Does *not* return the credentials configured by the administrator. Used by action execution and UI.

close()

Close httplib2 connections.

@@ -99,7 +99,7 @@

Instance Methods

Method Details

acquireAccessToken(name, body=None, x__xgafv=None) - 
Uses the per-user refresh token minted with AcquireAndStoreRefreshToken to generate and return a new access token and its details. Takes the access token from cache if available. Rotates the stored refresh token if needed. Uses the end user identity to return the user specific access token. Does *not* return the credentials configured by the administrator. Used by Agentspace action execution and Agentspace UI.
+  
Uses the per-user refresh token minted with AcquireAndStoreRefreshToken to generate and return a new access token and its details. Takes the access token from cache if available. Rotates the stored refresh token if needed. Uses the end user identity to return the user specific access token. Does *not* return the credentials configured by the administrator. Used by action execution and UI.
 
 Args:
   name: string, Required. The resource name of the connector for which a token is queried. (required)
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataConnector.operations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataConnector.operations.html
index daa67a57d33..131e0ed3e0d 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataConnector.operations.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataConnector.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/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.html index 9c9358b6495..36f6b24f177 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.html @@ -90,6 +90,12 @@

Instance Methods

close()

Close httplib2 connections.

+

+ get(name, view=None, x__xgafv=None)

+

Retrieves a Branch.

+

+ list(parent, view=None, x__xgafv=None)

+

Lists all Branchs under the specified parent DataStore.

Method Details

batchGetDocumentsMetadata(parent, matcher_fhirMatcher_fhirResources=None, matcher_urisMatcher_uris=None, x__xgafv=None) @@ -127,4 +133,72 @@

Method Details

Close httplib2 connections.
+
+ get(name, view=None, x__xgafv=None) + 
Retrieves a Branch.
+
+Args:
+  name: string, Required. The name of the branch to retrieve. Format: `projects/*/locations/global/dataStores/default_data_store/branches/some_branch_id`. "default_branch" can be used as a special branch_id, it returns the default branch that has been set for the document. (required)
+  view: string, The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified.
+    Allowed values
+      BRANCH_VIEW_UNSPECIFIED - The value when it's unspecified. This defaults to the BASIC view.
+      BRANCH_VIEW_BASIC - Includes basic metadata about the branch, but not statistical fields. See documentation of individual fields of Branch to know what is excluded.
+      BRANCH_VIEW_FULL - Includes all fields of a Branch.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A data branch that stores Documents.
+  "branchStats": { # Statistics describing a branch. # Output only. Stistics describing a branch. This field is not populated in BranchView.BASIC view.
+    "documentCounts": { # The number of documents in a given branch. The key is a group representing a set of documents, and the value is the number of document in that group. Note: keys in this map may change over time. Supported keys: ['all'].
+      "a_key": "A String",
+    },
+  },
+  "displayName": "A String", # Output only. Human readable name of the branch to display in the UI.
+  "isDefault": True or False, # Output only. Indicates whether this branch is set as the default branch of its parent data store.
+  "lastDocumentImportTime": "A String", # Output only. Timestamp of last import through DocumentService.ImportDocuments. Empty value means no import has been made to this branch.
+  "name": "A String", # Immutable. Full resource name of the branch, such as `projects/*/locations/global/dataStores/data_store/branches/branch_id`.
+}
+
+ +
+ list(parent, view=None, x__xgafv=None) + 
Lists all Branchs under the specified parent DataStore.
+
+Args:
+  parent: string, Required. The parent data store resource name. (required)
+  view: string, The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified.
+    Allowed values
+      BRANCH_VIEW_UNSPECIFIED - The value when it's unspecified. This defaults to the BASIC view.
+      BRANCH_VIEW_BASIC - Includes basic metadata about the branch, but not statistical fields. See documentation of individual fields of Branch to know what is excluded.
+      BRANCH_VIEW_FULL - Includes all fields of a Branch.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for BranchService.ListBranches method.
+  "branches": [ # The Branches.
+    { # A data branch that stores Documents.
+      "branchStats": { # Statistics describing a branch. # Output only. Stistics describing a branch. This field is not populated in BranchView.BASIC view.
+        "documentCounts": { # The number of documents in a given branch. The key is a group representing a set of documents, and the value is the number of document in that group. Note: keys in this map may change over time. Supported keys: ['all'].
+          "a_key": "A String",
+        },
+      },
+      "displayName": "A String", # Output only. Human readable name of the branch to display in the UI.
+      "isDefault": True or False, # Output only. Indicates whether this branch is set as the default branch of its parent data store.
+      "lastDocumentImportTime": "A String", # Output only. Timestamp of last import through DocumentService.ImportDocuments. Empty value means no import has been made to this branch.
+      "name": "A String", # Immutable. Full resource name of the branch, such as `projects/*/locations/global/dataStores/data_store/branches/branch_id`.
+    },
+  ],
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.operations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.operations.html index 57816fcac93..ec9fe4bb935 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.operations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.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/discoveryengine_v1alpha.projects.locations.collections.dataStores.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html index f5395f7614e..3181d3d3afd 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html @@ -259,6 +259,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. "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. @@ -504,6 +505,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. "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. @@ -786,6 +788,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. "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. @@ -975,6 +978,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. "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. @@ -1146,6 +1150,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. "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.models.operations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.models.operations.html index bfeeba2895a..6e34d60751c 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.models.operations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.models.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/discoveryengine_v1alpha.projects.locations.collections.dataStores.operations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.operations.html index 1152fe256f1..81ea58e8777 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.operations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.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/discoveryengine_v1alpha.projects.locations.collections.dataStores.schemas.operations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.schemas.operations.html index 8420fddec92..0a636d2ace8 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.schemas.operations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.schemas.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/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html index 99993ae8377..8c9c4790377 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html @@ -1200,7 +1200,7 @@

Method Details

], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. - "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. + "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. "mediaInfo": { # Media-specific user event information. # Media-specific info. "mediaProgressDuration": "A String", # The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be set to 90. @@ -1505,7 +1505,7 @@

Method Details

"imageBytes": "A String", # Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP. }, "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. - "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. + "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored. "A String", ], @@ -1539,7 +1539,7 @@

Method Details

}, "relevanceThreshold": "A String", # The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search. "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search. - "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. This field is only supported for search requests. + "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. This field is only supported for search requests. "disableGenerativeAnswerAddOn": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers. "disableKpiPersonalizationAddOn": True or False, # Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results. "disableSemanticAddOn": True or False, # Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream. @@ -2130,7 +2130,7 @@

Method Details

"imageBytes": "A String", # Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP. }, "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. - "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. + "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored. "A String", ], @@ -2164,7 +2164,7 @@

Method Details

}, "relevanceThreshold": "A String", # The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search. "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search. - "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. This field is only supported for search requests. + "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. This field is only supported for search requests. "disableGenerativeAnswerAddOn": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers. "disableKpiPersonalizationAddOn": True or False, # Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results. "disableSemanticAddOn": True or False, # Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.siteSearchEngine.operations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.siteSearchEngine.operations.html index 417058a46cf..4f03f7b0cad 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.siteSearchEngine.operations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.siteSearchEngine.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/discoveryengine_v1alpha.projects.locations.collections.dataStores.siteSearchEngine.targetSites.operations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.siteSearchEngine.targetSites.operations.html index ca1d3145e12..55895198c4f 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.siteSearchEngine.targetSites.operations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.siteSearchEngine.targetSites.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/discoveryengine_v1alpha.projects.locations.collections.dataStores.userEvents.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.userEvents.html index f48f649e425..098039e025c 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.userEvents.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.userEvents.html @@ -190,7 +190,7 @@

Method Details

], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. - "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. + "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. "mediaInfo": { # Media-specific user event information. # Media-specific info. "mediaProgressDuration": "A String", # The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be set to 90. @@ -388,7 +388,7 @@

Method Details

], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. - "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. + "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. "mediaInfo": { # Media-specific user event information. # Media-specific info. "mediaProgressDuration": "A String", # The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be set to 90. @@ -511,7 +511,7 @@

Method Details

], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. - "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. + "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. "mediaInfo": { # Media-specific user event information. # Media-specific info. "mediaProgressDuration": "A String", # The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be set to 90. 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 e64d328ac19..8206d9f04ec 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.widgetConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.widgetConfigs.html @@ -291,7 +291,7 @@

Method Details

"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-image-generation` * `disable-video-generation` + "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-image-generation` * `disable-video-generation` * `disable-onedrive-upload` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. 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 56bd84bdf0f..196121e0b9d 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.html @@ -380,6 +380,7 @@

Method Details

], }, }, + "replyId": "A String", # Output only. When set, uniquely identifies a reply within the `AssistAnswer` resource. During an AssistantService.StreamAssist call, multiple `Reply` messages with the same ID can occur within the response stream (across multiple AssistantService.StreamAssistResponse messages). These represent parts of a single `Reply` message in the final `AssistAnswer` resource. }, ], "state": "A String", # State of the answer generation. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html index 14edf1b019f..8e76c3a18e1 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html @@ -189,7 +189,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation` * `disable-onedrive-upload` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -334,7 +334,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation` * `disable-onedrive-upload` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -420,7 +420,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation` * `disable-onedrive-upload` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -513,7 +513,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation` * `disable-onedrive-upload` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -588,7 +588,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation` * `disable-onedrive-upload` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -675,7 +675,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation` * `disable-onedrive-upload` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -762,7 +762,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation` * `disable-onedrive-upload` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.operations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.operations.html index 1f484a6fa1f..f6647aeaaea 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.operations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.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/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html index 4587f407160..cdeb0c09f65 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html @@ -1200,7 +1200,7 @@

Method Details

], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. - "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. + "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. "mediaInfo": { # Media-specific user event information. # Media-specific info. "mediaProgressDuration": "A String", # The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be set to 90. @@ -1505,7 +1505,7 @@

Method Details

"imageBytes": "A String", # Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP. }, "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. - "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. + "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored. "A String", ], @@ -1539,7 +1539,7 @@

Method Details

}, "relevanceThreshold": "A String", # The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search. "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search. - "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. This field is only supported for search requests. + "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. This field is only supported for search requests. "disableGenerativeAnswerAddOn": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers. "disableKpiPersonalizationAddOn": True or False, # Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results. "disableSemanticAddOn": True or False, # Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream. @@ -2130,7 +2130,7 @@

Method Details

"imageBytes": "A String", # Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP. }, "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. - "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. + "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored. "A String", ], @@ -2164,7 +2164,7 @@

Method Details

}, "relevanceThreshold": "A String", # The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search. "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search. - "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. This field is only supported for search requests. + "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. This field is only supported for search requests. "disableGenerativeAnswerAddOn": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers. "disableKpiPersonalizationAddOn": True or False, # Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results. "disableSemanticAddOn": True or False, # Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream. 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 778307cf53e..af65130f913 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.widgetConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.widgetConfigs.html @@ -291,7 +291,7 @@

Method Details

"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-image-generation` * `disable-video-generation` + "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-image-generation` * `disable-video-generation` * `disable-onedrive-upload` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html index 332b5ae6aba..b2ca7ecbbab 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html @@ -178,10 +178,11 @@

Method Details

"dataConnector": { # Manages the connection to external data sources for all data stores grouped under a Collection. It's a singleton resource of Collection. The initialization is only supported through DataConnectorService.SetUpDataConnector method, which will create a new Collection and initialize its DataConnector. # Output only. The data connector, if present, manages the connection for data stores in the Collection. To set up the connector, use DataConnectorService.SetUpDataConnector method, which creates a new Collection while setting up the DataConnector singleton resource. Setting up connector on an existing Collection is not supported. This output only field contains a subset of the DataConnector fields, including `name`, `data_source`, `entities.entity_name` and `entities.data_store`. To get more details about a data connector, use the DataConnectorService.GetDataConnector method. "aclEnabled": True or False, # Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors. "actionConfig": { # Informations to support actions on the connector. # Optional. Action configurations to make the connector support actions. - "actionParams": { # Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client ID for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server. + "actionParams": { # Optional. Action parameters in structured json format. "a_key": "", # Properties of the object. }, "isActionConfigured": True or False, # Output only. The connector contains the necessary parameters and is configured to support actions. + "jsonActionParams": "A String", # Optional. Action parameters in json string format. "serviceName": "A String", # Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled. "useStaticSecrets": True or False, # Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored. }, @@ -199,6 +200,9 @@

Method Details

], "autoRunDisabled": True or False, # Optional. Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. Update: with the introduction of incremental_sync_disabled, auto_run_disabled is used to pause/disable only full syncs "bapConfig": { # The configuration for the BAP connector. # Optional. The configuration for establishing a BAP connection. + "enabledActions": [ # Optional. The actions enabled on the associated BAP connection. + "A String", + ], "supportedConnectorModes": [ # Required. The supported connector modes for the associated BAP connection. "A String", ], @@ -235,6 +239,7 @@

Method Details

"authParams": { # Optional. Any authentication parameters specific to EUA connectors. "a_key": "", # Properties of the object. }, + "jsonAuthParams": "A String", # Optional. Any authentication parameters specific to EUA connectors in json string format. "tenant": { # Tenant information for a connector source. This includes some of the same information stored in the Credential message, but is limited to only what is needed to provide a list of accessible tenants to the user. # Optional. The tenant project the connector is connected to. "displayName": "A String", # Optional display name for the tenant, e.g. "My Slack Team". "id": "A String", # The tenant's instance ID. Examples: Jira ("8594f221-9797-5f78-1fa4-485e198d7cd0"), Slack ("T123456"). @@ -300,9 +305,10 @@

Method Details

"additionalParams": { # Optional. Any additional parameters needed for FEDERATED. "a_key": "", # Properties of the object. }, - "authParams": { # Optional. Any authentication parameters specific to FEDERATED. + "authParams": { # Optional. Any authentication parameters specific to FEDERATED connectors. "a_key": "", # Properties of the object. }, + "jsonAuthParams": "A String", # Optional. Any authentication parameters specific to FEDERATED connectors in json string format. }, "hybridIngestionDisabled": True or False, # Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored. "identityRefreshInterval": "A String", # The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days. @@ -399,10 +405,11 @@

Method Details

{ # Manages the connection to external data sources for all data stores grouped under a Collection. It's a singleton resource of Collection. The initialization is only supported through DataConnectorService.SetUpDataConnector method, which will create a new Collection and initialize its DataConnector. "aclEnabled": True or False, # Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors. "actionConfig": { # Informations to support actions on the connector. # Optional. Action configurations to make the connector support actions. - "actionParams": { # Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client ID for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server. + "actionParams": { # Optional. Action parameters in structured json format. "a_key": "", # Properties of the object. }, "isActionConfigured": True or False, # Output only. The connector contains the necessary parameters and is configured to support actions. + "jsonActionParams": "A String", # Optional. Action parameters in json string format. "serviceName": "A String", # Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled. "useStaticSecrets": True or False, # Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored. }, @@ -420,6 +427,9 @@

Method Details

], "autoRunDisabled": True or False, # Optional. Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. Update: with the introduction of incremental_sync_disabled, auto_run_disabled is used to pause/disable only full syncs "bapConfig": { # The configuration for the BAP connector. # Optional. The configuration for establishing a BAP connection. + "enabledActions": [ # Optional. The actions enabled on the associated BAP connection. + "A String", + ], "supportedConnectorModes": [ # Required. The supported connector modes for the associated BAP connection. "A String", ], @@ -456,6 +466,7 @@

Method Details

"authParams": { # Optional. Any authentication parameters specific to EUA connectors. "a_key": "", # Properties of the object. }, + "jsonAuthParams": "A String", # Optional. Any authentication parameters specific to EUA connectors in json string format. "tenant": { # Tenant information for a connector source. This includes some of the same information stored in the Credential message, but is limited to only what is needed to provide a list of accessible tenants to the user. # Optional. The tenant project the connector is connected to. "displayName": "A String", # Optional display name for the tenant, e.g. "My Slack Team". "id": "A String", # The tenant's instance ID. Examples: Jira ("8594f221-9797-5f78-1fa4-485e198d7cd0"), Slack ("T123456"). @@ -521,9 +532,10 @@

Method Details

"additionalParams": { # Optional. Any additional parameters needed for FEDERATED. "a_key": "", # Properties of the object. }, - "authParams": { # Optional. Any authentication parameters specific to FEDERATED. + "authParams": { # Optional. Any authentication parameters specific to FEDERATED connectors. "a_key": "", # Properties of the object. }, + "jsonAuthParams": "A String", # Optional. Any authentication parameters specific to FEDERATED connectors in json string format. }, "hybridIngestionDisabled": True or False, # Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored. "identityRefreshInterval": "A String", # The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days. @@ -624,10 +636,11 @@

Method Details

"dataConnector": { # Manages the connection to external data sources for all data stores grouped under a Collection. It's a singleton resource of Collection. The initialization is only supported through DataConnectorService.SetUpDataConnector method, which will create a new Collection and initialize its DataConnector. # Output only. The data connector, if present, manages the connection for data stores in the Collection. To set up the connector, use DataConnectorService.SetUpDataConnector method, which creates a new Collection while setting up the DataConnector singleton resource. Setting up connector on an existing Collection is not supported. This output only field contains a subset of the DataConnector fields, including `name`, `data_source`, `entities.entity_name` and `entities.data_store`. To get more details about a data connector, use the DataConnectorService.GetDataConnector method. "aclEnabled": True or False, # Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors. "actionConfig": { # Informations to support actions on the connector. # Optional. Action configurations to make the connector support actions. - "actionParams": { # Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client ID for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server. + "actionParams": { # Optional. Action parameters in structured json format. "a_key": "", # Properties of the object. }, "isActionConfigured": True or False, # Output only. The connector contains the necessary parameters and is configured to support actions. + "jsonActionParams": "A String", # Optional. Action parameters in json string format. "serviceName": "A String", # Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled. "useStaticSecrets": True or False, # Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored. }, @@ -645,6 +658,9 @@

Method Details

], "autoRunDisabled": True or False, # Optional. Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. Update: with the introduction of incremental_sync_disabled, auto_run_disabled is used to pause/disable only full syncs "bapConfig": { # The configuration for the BAP connector. # Optional. The configuration for establishing a BAP connection. + "enabledActions": [ # Optional. The actions enabled on the associated BAP connection. + "A String", + ], "supportedConnectorModes": [ # Required. The supported connector modes for the associated BAP connection. "A String", ], @@ -681,6 +697,7 @@

Method Details

"authParams": { # Optional. Any authentication parameters specific to EUA connectors. "a_key": "", # Properties of the object. }, + "jsonAuthParams": "A String", # Optional. Any authentication parameters specific to EUA connectors in json string format. "tenant": { # Tenant information for a connector source. This includes some of the same information stored in the Credential message, but is limited to only what is needed to provide a list of accessible tenants to the user. # Optional. The tenant project the connector is connected to. "displayName": "A String", # Optional display name for the tenant, e.g. "My Slack Team". "id": "A String", # The tenant's instance ID. Examples: Jira ("8594f221-9797-5f78-1fa4-485e198d7cd0"), Slack ("T123456"). @@ -746,9 +763,10 @@

Method Details

"additionalParams": { # Optional. Any additional parameters needed for FEDERATED. "a_key": "", # Properties of the object. }, - "authParams": { # Optional. Any authentication parameters specific to FEDERATED. + "authParams": { # Optional. Any authentication parameters specific to FEDERATED connectors. "a_key": "", # Properties of the object. }, + "jsonAuthParams": "A String", # Optional. Any authentication parameters specific to FEDERATED connectors in json string format. }, "hybridIngestionDisabled": True or False, # Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored. "identityRefreshInterval": "A String", # The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days. @@ -859,10 +877,11 @@

Method Details

"dataConnector": { # Manages the connection to external data sources for all data stores grouped under a Collection. It's a singleton resource of Collection. The initialization is only supported through DataConnectorService.SetUpDataConnector method, which will create a new Collection and initialize its DataConnector. # Output only. The data connector, if present, manages the connection for data stores in the Collection. To set up the connector, use DataConnectorService.SetUpDataConnector method, which creates a new Collection while setting up the DataConnector singleton resource. Setting up connector on an existing Collection is not supported. This output only field contains a subset of the DataConnector fields, including `name`, `data_source`, `entities.entity_name` and `entities.data_store`. To get more details about a data connector, use the DataConnectorService.GetDataConnector method. "aclEnabled": True or False, # Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors. "actionConfig": { # Informations to support actions on the connector. # Optional. Action configurations to make the connector support actions. - "actionParams": { # Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client ID for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server. + "actionParams": { # Optional. Action parameters in structured json format. "a_key": "", # Properties of the object. }, "isActionConfigured": True or False, # Output only. The connector contains the necessary parameters and is configured to support actions. + "jsonActionParams": "A String", # Optional. Action parameters in json string format. "serviceName": "A String", # Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled. "useStaticSecrets": True or False, # Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored. }, @@ -880,6 +899,9 @@

Method Details

], "autoRunDisabled": True or False, # Optional. Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. Update: with the introduction of incremental_sync_disabled, auto_run_disabled is used to pause/disable only full syncs "bapConfig": { # The configuration for the BAP connector. # Optional. The configuration for establishing a BAP connection. + "enabledActions": [ # Optional. The actions enabled on the associated BAP connection. + "A String", + ], "supportedConnectorModes": [ # Required. The supported connector modes for the associated BAP connection. "A String", ], @@ -916,6 +938,7 @@

Method Details

"authParams": { # Optional. Any authentication parameters specific to EUA connectors. "a_key": "", # Properties of the object. }, + "jsonAuthParams": "A String", # Optional. Any authentication parameters specific to EUA connectors in json string format. "tenant": { # Tenant information for a connector source. This includes some of the same information stored in the Credential message, but is limited to only what is needed to provide a list of accessible tenants to the user. # Optional. The tenant project the connector is connected to. "displayName": "A String", # Optional display name for the tenant, e.g. "My Slack Team". "id": "A String", # The tenant's instance ID. Examples: Jira ("8594f221-9797-5f78-1fa4-485e198d7cd0"), Slack ("T123456"). @@ -981,9 +1004,10 @@

Method Details

"additionalParams": { # Optional. Any additional parameters needed for FEDERATED. "a_key": "", # Properties of the object. }, - "authParams": { # Optional. Any authentication parameters specific to FEDERATED. + "authParams": { # Optional. Any authentication parameters specific to FEDERATED connectors. "a_key": "", # Properties of the object. }, + "jsonAuthParams": "A String", # Optional. Any authentication parameters specific to FEDERATED connectors in json string format. }, "hybridIngestionDisabled": True or False, # Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored. "identityRefreshInterval": "A String", # The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days. @@ -1104,10 +1128,11 @@

Method Details

{ # Manages the connection to external data sources for all data stores grouped under a Collection. It's a singleton resource of Collection. The initialization is only supported through DataConnectorService.SetUpDataConnector method, which will create a new Collection and initialize its DataConnector. "aclEnabled": True or False, # Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors. "actionConfig": { # Informations to support actions on the connector. # Optional. Action configurations to make the connector support actions. - "actionParams": { # Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client ID for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server. + "actionParams": { # Optional. Action parameters in structured json format. "a_key": "", # Properties of the object. }, "isActionConfigured": True or False, # Output only. The connector contains the necessary parameters and is configured to support actions. + "jsonActionParams": "A String", # Optional. Action parameters in json string format. "serviceName": "A String", # Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled. "useStaticSecrets": True or False, # Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored. }, @@ -1125,6 +1150,9 @@

Method Details

], "autoRunDisabled": True or False, # Optional. Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. Update: with the introduction of incremental_sync_disabled, auto_run_disabled is used to pause/disable only full syncs "bapConfig": { # The configuration for the BAP connector. # Optional. The configuration for establishing a BAP connection. + "enabledActions": [ # Optional. The actions enabled on the associated BAP connection. + "A String", + ], "supportedConnectorModes": [ # Required. The supported connector modes for the associated BAP connection. "A String", ], @@ -1161,6 +1189,7 @@

Method Details

"authParams": { # Optional. Any authentication parameters specific to EUA connectors. "a_key": "", # Properties of the object. }, + "jsonAuthParams": "A String", # Optional. Any authentication parameters specific to EUA connectors in json string format. "tenant": { # Tenant information for a connector source. This includes some of the same information stored in the Credential message, but is limited to only what is needed to provide a list of accessible tenants to the user. # Optional. The tenant project the connector is connected to. "displayName": "A String", # Optional display name for the tenant, e.g. "My Slack Team". "id": "A String", # The tenant's instance ID. Examples: Jira ("8594f221-9797-5f78-1fa4-485e198d7cd0"), Slack ("T123456"). @@ -1226,9 +1255,10 @@

Method Details

"additionalParams": { # Optional. Any additional parameters needed for FEDERATED. "a_key": "", # Properties of the object. }, - "authParams": { # Optional. Any authentication parameters specific to FEDERATED. + "authParams": { # Optional. Any authentication parameters specific to FEDERATED connectors. "a_key": "", # Properties of the object. }, + "jsonAuthParams": "A String", # Optional. Any authentication parameters specific to FEDERATED connectors in json string format. }, "hybridIngestionDisabled": True or False, # Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored. "identityRefreshInterval": "A String", # The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days. @@ -1316,10 +1346,11 @@

Method Details

{ # Manages the connection to external data sources for all data stores grouped under a Collection. It's a singleton resource of Collection. The initialization is only supported through DataConnectorService.SetUpDataConnector method, which will create a new Collection and initialize its DataConnector. "aclEnabled": True or False, # Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors. "actionConfig": { # Informations to support actions on the connector. # Optional. Action configurations to make the connector support actions. - "actionParams": { # Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client ID for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server. + "actionParams": { # Optional. Action parameters in structured json format. "a_key": "", # Properties of the object. }, "isActionConfigured": True or False, # Output only. The connector contains the necessary parameters and is configured to support actions. + "jsonActionParams": "A String", # Optional. Action parameters in json string format. "serviceName": "A String", # Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled. "useStaticSecrets": True or False, # Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored. }, @@ -1337,6 +1368,9 @@

Method Details

], "autoRunDisabled": True or False, # Optional. Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. Update: with the introduction of incremental_sync_disabled, auto_run_disabled is used to pause/disable only full syncs "bapConfig": { # The configuration for the BAP connector. # Optional. The configuration for establishing a BAP connection. + "enabledActions": [ # Optional. The actions enabled on the associated BAP connection. + "A String", + ], "supportedConnectorModes": [ # Required. The supported connector modes for the associated BAP connection. "A String", ], @@ -1373,6 +1407,7 @@

Method Details

"authParams": { # Optional. Any authentication parameters specific to EUA connectors. "a_key": "", # Properties of the object. }, + "jsonAuthParams": "A String", # Optional. Any authentication parameters specific to EUA connectors in json string format. "tenant": { # Tenant information for a connector source. This includes some of the same information stored in the Credential message, but is limited to only what is needed to provide a list of accessible tenants to the user. # Optional. The tenant project the connector is connected to. "displayName": "A String", # Optional display name for the tenant, e.g. "My Slack Team". "id": "A String", # The tenant's instance ID. Examples: Jira ("8594f221-9797-5f78-1fa4-485e198d7cd0"), Slack ("T123456"). @@ -1438,9 +1473,10 @@

Method Details

"additionalParams": { # Optional. Any additional parameters needed for FEDERATED. "a_key": "", # Properties of the object. }, - "authParams": { # Optional. Any authentication parameters specific to FEDERATED. + "authParams": { # Optional. Any authentication parameters specific to FEDERATED connectors. "a_key": "", # Properties of the object. }, + "jsonAuthParams": "A String", # Optional. Any authentication parameters specific to FEDERATED connectors in json string format. }, "hybridIngestionDisabled": True or False, # Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored. "identityRefreshInterval": "A String", # The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.operations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.operations.html index bdcda056050..b3a4868021d 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.operations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.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/discoveryengine_v1alpha.projects.locations.dataStores.branches.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.html index 3deef17fcb0..b8fe61415f6 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.html @@ -90,6 +90,12 @@

Instance Methods

close()

Close httplib2 connections.

+

+ get(name, view=None, x__xgafv=None)

+

Retrieves a Branch.

+

+ list(parent, view=None, x__xgafv=None)

+

Lists all Branchs under the specified parent DataStore.

Method Details

batchGetDocumentsMetadata(parent, matcher_fhirMatcher_fhirResources=None, matcher_urisMatcher_uris=None, x__xgafv=None) @@ -127,4 +133,72 @@

Method Details

Close httplib2 connections.
+
+ get(name, view=None, x__xgafv=None) + 
Retrieves a Branch.
+
+Args:
+  name: string, Required. The name of the branch to retrieve. Format: `projects/*/locations/global/dataStores/default_data_store/branches/some_branch_id`. "default_branch" can be used as a special branch_id, it returns the default branch that has been set for the document. (required)
+  view: string, The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified.
+    Allowed values
+      BRANCH_VIEW_UNSPECIFIED - The value when it's unspecified. This defaults to the BASIC view.
+      BRANCH_VIEW_BASIC - Includes basic metadata about the branch, but not statistical fields. See documentation of individual fields of Branch to know what is excluded.
+      BRANCH_VIEW_FULL - Includes all fields of a Branch.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A data branch that stores Documents.
+  "branchStats": { # Statistics describing a branch. # Output only. Stistics describing a branch. This field is not populated in BranchView.BASIC view.
+    "documentCounts": { # The number of documents in a given branch. The key is a group representing a set of documents, and the value is the number of document in that group. Note: keys in this map may change over time. Supported keys: ['all'].
+      "a_key": "A String",
+    },
+  },
+  "displayName": "A String", # Output only. Human readable name of the branch to display in the UI.
+  "isDefault": True or False, # Output only. Indicates whether this branch is set as the default branch of its parent data store.
+  "lastDocumentImportTime": "A String", # Output only. Timestamp of last import through DocumentService.ImportDocuments. Empty value means no import has been made to this branch.
+  "name": "A String", # Immutable. Full resource name of the branch, such as `projects/*/locations/global/dataStores/data_store/branches/branch_id`.
+}
+
+ +
+ list(parent, view=None, x__xgafv=None) + 
Lists all Branchs under the specified parent DataStore.
+
+Args:
+  parent: string, Required. The parent data store resource name. (required)
+  view: string, The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified.
+    Allowed values
+      BRANCH_VIEW_UNSPECIFIED - The value when it's unspecified. This defaults to the BASIC view.
+      BRANCH_VIEW_BASIC - Includes basic metadata about the branch, but not statistical fields. See documentation of individual fields of Branch to know what is excluded.
+      BRANCH_VIEW_FULL - Includes all fields of a Branch.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for BranchService.ListBranches method.
+  "branches": [ # The Branches.
+    { # A data branch that stores Documents.
+      "branchStats": { # Statistics describing a branch. # Output only. Stistics describing a branch. This field is not populated in BranchView.BASIC view.
+        "documentCounts": { # The number of documents in a given branch. The key is a group representing a set of documents, and the value is the number of document in that group. Note: keys in this map may change over time. Supported keys: ['all'].
+          "a_key": "A String",
+        },
+      },
+      "displayName": "A String", # Output only. Human readable name of the branch to display in the UI.
+      "isDefault": True or False, # Output only. Indicates whether this branch is set as the default branch of its parent data store.
+      "lastDocumentImportTime": "A String", # Output only. Timestamp of last import through DocumentService.ImportDocuments. Empty value means no import has been made to this branch.
+      "name": "A String", # Immutable. Full resource name of the branch, such as `projects/*/locations/global/dataStores/data_store/branches/branch_id`.
+    },
+  ],
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.operations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.operations.html index e8461ba4f14..b6eb776120e 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.operations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.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/discoveryengine_v1alpha.projects.locations.dataStores.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html index 4c182946e85..4686192f889 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html @@ -251,6 +251,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. "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. @@ -496,6 +497,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. "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. @@ -778,6 +780,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. "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. @@ -967,6 +970,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. "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. @@ -1138,6 +1142,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. "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.models.operations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.models.operations.html index cf0d86671a9..7d0eb408f47 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.models.operations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.models.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/discoveryengine_v1alpha.projects.locations.dataStores.operations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.operations.html index 179a2a95c0a..39f6f4fa676 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.operations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.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/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html index 3982ea80793..27e8864b003 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html @@ -1200,7 +1200,7 @@

Method Details

], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. - "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. + "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. "mediaInfo": { # Media-specific user event information. # Media-specific info. "mediaProgressDuration": "A String", # The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be set to 90. @@ -1505,7 +1505,7 @@

Method Details

"imageBytes": "A String", # Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP. }, "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. - "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. + "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored. "A String", ], @@ -1539,7 +1539,7 @@

Method Details

}, "relevanceThreshold": "A String", # The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search. "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search. - "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. This field is only supported for search requests. + "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. This field is only supported for search requests. "disableGenerativeAnswerAddOn": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers. "disableKpiPersonalizationAddOn": True or False, # Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results. "disableSemanticAddOn": True or False, # Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream. @@ -2130,7 +2130,7 @@

Method Details

"imageBytes": "A String", # Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP. }, "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. - "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. + "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored. "A String", ], @@ -2164,7 +2164,7 @@

Method Details

}, "relevanceThreshold": "A String", # The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search. "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search. - "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. This field is only supported for search requests. + "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. This field is only supported for search requests. "disableGenerativeAnswerAddOn": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers. "disableKpiPersonalizationAddOn": True or False, # Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results. "disableSemanticAddOn": True or False, # Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.userEvents.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.userEvents.html index 2e46d3f2ee8..5f8e7e2b476 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.userEvents.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.userEvents.html @@ -190,7 +190,7 @@

Method Details

], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. - "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. + "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. "mediaInfo": { # Media-specific user event information. # Media-specific info. "mediaProgressDuration": "A String", # The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be set to 90. @@ -388,7 +388,7 @@

Method Details

], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. - "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. + "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. "mediaInfo": { # Media-specific user event information. # Media-specific info. "mediaProgressDuration": "A String", # The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be set to 90. @@ -511,7 +511,7 @@

Method Details

], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. - "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. + "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. "mediaInfo": { # Media-specific user event information. # Media-specific info. "mediaProgressDuration": "A String", # The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be set to 90. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html index a03ecefce27..b39ec57857c 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html @@ -291,7 +291,7 @@

Method Details

"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-image-generation` * `disable-video-generation` + "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-image-generation` * `disable-video-generation` * `disable-onedrive-upload` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html index 67389f2271f..43fca6973b3 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html @@ -280,7 +280,7 @@

Method Details

"imageBytes": "A String", # Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP. }, "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. - "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. + "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored. "A String", ], @@ -314,7 +314,7 @@

Method Details

}, "relevanceThreshold": "A String", # The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search. "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search. - "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. This field is only supported for search requests. + "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. This field is only supported for search requests. "disableGenerativeAnswerAddOn": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers. "disableKpiPersonalizationAddOn": True or False, # Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results. "disableSemanticAddOn": True or False, # Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream. @@ -587,7 +587,7 @@

Method Details

"imageBytes": "A String", # Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP. }, "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. - "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. + "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored. "A String", ], @@ -621,7 +621,7 @@

Method Details

}, "relevanceThreshold": "A String", # The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search. "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search. - "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. This field is only supported for search requests. + "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. This field is only supported for search requests. "disableGenerativeAnswerAddOn": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers. "disableKpiPersonalizationAddOn": True or False, # Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results. "disableSemanticAddOn": True or False, # Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream. @@ -870,7 +870,7 @@

Method Details

"imageBytes": "A String", # Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP. }, "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. - "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. + "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored. "A String", ], @@ -904,7 +904,7 @@

Method Details

}, "relevanceThreshold": "A String", # The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search. "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search. - "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. This field is only supported for search requests. + "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. This field is only supported for search requests. "disableGenerativeAnswerAddOn": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers. "disableKpiPersonalizationAddOn": True or False, # Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results. "disableSemanticAddOn": True or False, # Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.html index 5276bf5998f..076f808cd43 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.html @@ -941,10 +941,11 @@

Method Details

"dataConnector": { # Manages the connection to external data sources for all data stores grouped under a Collection. It's a singleton resource of Collection. The initialization is only supported through DataConnectorService.SetUpDataConnector method, which will create a new Collection and initialize its DataConnector. # Required. The DataConnector to initialize in the newly created Collection. "aclEnabled": True or False, # Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors. "actionConfig": { # Informations to support actions on the connector. # Optional. Action configurations to make the connector support actions. - "actionParams": { # Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client ID for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server. + "actionParams": { # Optional. Action parameters in structured json format. "a_key": "", # Properties of the object. }, "isActionConfigured": True or False, # Output only. The connector contains the necessary parameters and is configured to support actions. + "jsonActionParams": "A String", # Optional. Action parameters in json string format. "serviceName": "A String", # Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled. "useStaticSecrets": True or False, # Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored. }, @@ -962,6 +963,9 @@

Method Details

], "autoRunDisabled": True or False, # Optional. Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. Update: with the introduction of incremental_sync_disabled, auto_run_disabled is used to pause/disable only full syncs "bapConfig": { # The configuration for the BAP connector. # Optional. The configuration for establishing a BAP connection. + "enabledActions": [ # Optional. The actions enabled on the associated BAP connection. + "A String", + ], "supportedConnectorModes": [ # Required. The supported connector modes for the associated BAP connection. "A String", ], @@ -998,6 +1002,7 @@

Method Details

"authParams": { # Optional. Any authentication parameters specific to EUA connectors. "a_key": "", # Properties of the object. }, + "jsonAuthParams": "A String", # Optional. Any authentication parameters specific to EUA connectors in json string format. "tenant": { # Tenant information for a connector source. This includes some of the same information stored in the Credential message, but is limited to only what is needed to provide a list of accessible tenants to the user. # Optional. The tenant project the connector is connected to. "displayName": "A String", # Optional display name for the tenant, e.g. "My Slack Team". "id": "A String", # The tenant's instance ID. Examples: Jira ("8594f221-9797-5f78-1fa4-485e198d7cd0"), Slack ("T123456"). @@ -1063,9 +1068,10 @@

Method Details

"additionalParams": { # Optional. Any additional parameters needed for FEDERATED. "a_key": "", # Properties of the object. }, - "authParams": { # Optional. Any authentication parameters specific to FEDERATED. + "authParams": { # Optional. Any authentication parameters specific to FEDERATED connectors. "a_key": "", # Properties of the object. }, + "jsonAuthParams": "A String", # Optional. Any authentication parameters specific to FEDERATED connectors in json string format. }, "hybridIngestionDisabled": True or False, # Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored. "identityRefreshInterval": "A String", # The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days. @@ -1183,10 +1189,11 @@

Method Details

{ # Manages the connection to external data sources for all data stores grouped under a Collection. It's a singleton resource of Collection. The initialization is only supported through DataConnectorService.SetUpDataConnector method, which will create a new Collection and initialize its DataConnector. "aclEnabled": True or False, # Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors. "actionConfig": { # Informations to support actions on the connector. # Optional. Action configurations to make the connector support actions. - "actionParams": { # Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client ID for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server. + "actionParams": { # Optional. Action parameters in structured json format. "a_key": "", # Properties of the object. }, "isActionConfigured": True or False, # Output only. The connector contains the necessary parameters and is configured to support actions. + "jsonActionParams": "A String", # Optional. Action parameters in json string format. "serviceName": "A String", # Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled. "useStaticSecrets": True or False, # Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored. }, @@ -1204,6 +1211,9 @@

Method Details

], "autoRunDisabled": True or False, # Optional. Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. Update: with the introduction of incremental_sync_disabled, auto_run_disabled is used to pause/disable only full syncs "bapConfig": { # The configuration for the BAP connector. # Optional. The configuration for establishing a BAP connection. + "enabledActions": [ # Optional. The actions enabled on the associated BAP connection. + "A String", + ], "supportedConnectorModes": [ # Required. The supported connector modes for the associated BAP connection. "A String", ], @@ -1240,6 +1250,7 @@

Method Details

"authParams": { # Optional. Any authentication parameters specific to EUA connectors. "a_key": "", # Properties of the object. }, + "jsonAuthParams": "A String", # Optional. Any authentication parameters specific to EUA connectors in json string format. "tenant": { # Tenant information for a connector source. This includes some of the same information stored in the Credential message, but is limited to only what is needed to provide a list of accessible tenants to the user. # Optional. The tenant project the connector is connected to. "displayName": "A String", # Optional display name for the tenant, e.g. "My Slack Team". "id": "A String", # The tenant's instance ID. Examples: Jira ("8594f221-9797-5f78-1fa4-485e198d7cd0"), Slack ("T123456"). @@ -1305,9 +1316,10 @@

Method Details

"additionalParams": { # Optional. Any additional parameters needed for FEDERATED. "a_key": "", # Properties of the object. }, - "authParams": { # Optional. Any authentication parameters specific to FEDERATED. + "authParams": { # Optional. Any authentication parameters specific to FEDERATED connectors. "a_key": "", # Properties of the object. }, + "jsonAuthParams": "A String", # Optional. Any authentication parameters specific to FEDERATED connectors in json string format. }, "hybridIngestionDisabled": True or False, # Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored. "identityRefreshInterval": "A String", # The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.identityMappingStores.operations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.identityMappingStores.operations.html index 567d42a2e55..cc0e36dc81b 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.identityMappingStores.operations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.identityMappingStores.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/discoveryengine_v1alpha.projects.locations.notebooks.sources.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.notebooks.sources.html index 17732cc22c9..9c69985b855 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.notebooks.sources.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.notebooks.sources.html @@ -103,9 +103,9 @@

Method Details

"userContents": [ # Required. The UserContents to be uploaded. { # The "Content" messages refer to data the user wants to upload. "agentspaceContent": { # Agentspace content uploaded as source. # Agentspace content uploaded as source. - "documentName": "A String", # Optional. The full document name in Agentspace. - "engineName": "A String", # Optional. Engine to verify the permission of the document. - "ideaforgeIdeaName": "A String", # Optional. The full idea name for IdeaForge. + "documentName": "A String", # Optional. The full resource name of the Agentspace document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. + "engineName": "A String", # Optional. Engine to verify the permission of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`. + "ideaforgeIdeaName": "A String", # Optional. Resource name of the idea forge instance. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/ideaForgeInstances/{instance}` }, "googleDriveContent": { # The content from Google Drive. # The content from Google Drive. "documentId": "A String", # The document id of the selected document. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.operations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.operations.html index bae3158b965..68dec313220 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.operations.html +++ b/docs/dyn/discoveryengine_v1alpha.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/discoveryengine_v1alpha.projects.locations.userEvents.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.userEvents.html index 49320a8c579..aadc8a0b7b0 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.userEvents.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.userEvents.html @@ -187,7 +187,7 @@

Method Details

], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. - "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. + "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. "mediaInfo": { # Media-specific user event information. # Media-specific info. "mediaProgressDuration": "A String", # The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be set to 90. @@ -342,7 +342,7 @@

Method Details

], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. - "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. + "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. "mediaInfo": { # Media-specific user event information. # Media-specific info. "mediaProgressDuration": "A String", # The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be set to 90. @@ -465,7 +465,7 @@

Method Details

], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. - "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. + "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. "mediaInfo": { # Media-specific user event information. # Media-specific info. "mediaProgressDuration": "A String", # The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be set to 90. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.userStores.operations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.userStores.operations.html index a902cbe89ef..173341a9b6c 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.userStores.operations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.userStores.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/discoveryengine_v1alpha.projects.operations.html b/docs/dyn/discoveryengine_v1alpha.projects.operations.html index e3215a434b1..7b8168c28de 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.operations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.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/discoveryengine_v1beta.projects.locations.collections.dataConnector.operations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataConnector.operations.html index e78723071fd..55ee39f451f 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataConnector.operations.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataConnector.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/discoveryengine_v1beta.projects.locations.collections.dataStores.branches.operations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.branches.operations.html index b6686cc7533..5a25cb65f9b 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.branches.operations.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.branches.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/discoveryengine_v1beta.projects.locations.collections.dataStores.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html index 9f1c44b9ce4..8f6f5ee8188 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html @@ -248,6 +248,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. "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. @@ -467,6 +468,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. "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. @@ -642,6 +644,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. "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. @@ -805,6 +808,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. "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. @@ -950,6 +954,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. "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.models.operations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.models.operations.html index 242a92ab0e4..d4857162ebe 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.models.operations.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.models.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/discoveryengine_v1beta.projects.locations.collections.dataStores.operations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.operations.html index 376445ee33b..6822e4d476c 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.operations.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.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/discoveryengine_v1beta.projects.locations.collections.dataStores.schemas.operations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.schemas.operations.html index 9e475e3d1db..f62f869e89b 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.schemas.operations.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.schemas.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/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html index 9ae5a1b2577..01b2f05fed1 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html @@ -1165,7 +1165,7 @@

Method Details

], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. - "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. + "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. "mediaInfo": { # Media-specific user event information. # Media-specific info. "mediaProgressDuration": "A String", # The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be set to 90. @@ -1467,7 +1467,7 @@

Method Details

"imageBytes": "A String", # Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP. }, "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. - "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. + "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored. "A String", ], @@ -1501,7 +1501,7 @@

Method Details

}, "relevanceThreshold": "A String", # The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search. "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search. - "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. This field is only supported for search requests. + "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. This field is only supported for search requests. "disableGenerativeAnswerAddOn": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers. "disableKpiPersonalizationAddOn": True or False, # Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results. "disableSemanticAddOn": True or False, # Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream. @@ -2088,7 +2088,7 @@

Method Details

"imageBytes": "A String", # Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP. }, "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. - "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. + "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored. "A String", ], @@ -2122,7 +2122,7 @@

Method Details

}, "relevanceThreshold": "A String", # The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search. "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search. - "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. This field is only supported for search requests. + "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. This field is only supported for search requests. "disableGenerativeAnswerAddOn": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers. "disableKpiPersonalizationAddOn": True or False, # Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results. "disableSemanticAddOn": True or False, # Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.siteSearchEngine.operations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.siteSearchEngine.operations.html index 686bc414210..5124b189e24 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.siteSearchEngine.operations.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.siteSearchEngine.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/discoveryengine_v1beta.projects.locations.collections.dataStores.siteSearchEngine.targetSites.operations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.siteSearchEngine.targetSites.operations.html index c2c0eb1dbed..9bb8ec35135 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.siteSearchEngine.targetSites.operations.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.siteSearchEngine.targetSites.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/discoveryengine_v1beta.projects.locations.collections.dataStores.userEvents.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.userEvents.html index e0b4f784b52..46168815169 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.userEvents.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.userEvents.html @@ -190,7 +190,7 @@

Method Details

], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. - "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. + "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. "mediaInfo": { # Media-specific user event information. # Media-specific info. "mediaProgressDuration": "A String", # The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be set to 90. @@ -388,7 +388,7 @@

Method Details

], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. - "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. + "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. "mediaInfo": { # Media-specific user event information. # Media-specific info. "mediaProgressDuration": "A String", # The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be set to 90. @@ -511,7 +511,7 @@

Method Details

], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. - "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. + "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. "mediaInfo": { # Media-specific user event information. # Media-specific info. "mediaProgressDuration": "A String", # The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be set to 90. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html index 2b66e8f53ea..8afa0d3f9aa 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html @@ -179,7 +179,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation` * `disable-onedrive-upload` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -315,7 +315,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation` * `disable-onedrive-upload` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -392,7 +392,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation` * `disable-onedrive-upload` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -476,7 +476,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation` * `disable-onedrive-upload` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -542,7 +542,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation` * `disable-onedrive-upload` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -620,7 +620,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation` * `disable-onedrive-upload` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -698,7 +698,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation` * `disable-onedrive-upload` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.operations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.operations.html index 67c4e743bd9..d14f79579da 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.operations.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.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/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html index 77b37d25fef..059af78dda1 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html @@ -1165,7 +1165,7 @@

Method Details

], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. - "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. + "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. "mediaInfo": { # Media-specific user event information. # Media-specific info. "mediaProgressDuration": "A String", # The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be set to 90. @@ -1467,7 +1467,7 @@

Method Details

"imageBytes": "A String", # Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP. }, "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. - "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. + "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored. "A String", ], @@ -1501,7 +1501,7 @@

Method Details

}, "relevanceThreshold": "A String", # The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search. "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search. - "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. This field is only supported for search requests. + "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. This field is only supported for search requests. "disableGenerativeAnswerAddOn": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers. "disableKpiPersonalizationAddOn": True or False, # Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results. "disableSemanticAddOn": True or False, # Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream. @@ -2088,7 +2088,7 @@

Method Details

"imageBytes": "A String", # Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP. }, "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. - "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. + "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored. "A String", ], @@ -2122,7 +2122,7 @@

Method Details

}, "relevanceThreshold": "A String", # The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search. "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search. - "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. This field is only supported for search requests. + "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. This field is only supported for search requests. "disableGenerativeAnswerAddOn": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers. "disableKpiPersonalizationAddOn": True or False, # Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results. "disableSemanticAddOn": True or False, # Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.operations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.operations.html index c18d69ac91c..f1383d1f6cb 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.operations.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.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/discoveryengine_v1beta.projects.locations.dataStores.branches.operations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.branches.operations.html index 079d1b890a8..9c355d70221 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.branches.operations.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.branches.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/discoveryengine_v1beta.projects.locations.dataStores.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html index cd218150cff..5b8a7f90cb3 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html @@ -240,6 +240,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. "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. @@ -459,6 +460,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. "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. @@ -634,6 +636,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. "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. @@ -797,6 +800,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. "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. @@ -942,6 +946,7 @@

Method Details

], "state": "A String", # Output only. The states of the CmekConfig. }, + "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search. "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.models.operations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.models.operations.html index a3ebf6f0405..441b573d6b7 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.models.operations.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.models.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/discoveryengine_v1beta.projects.locations.dataStores.operations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.operations.html index 180f85f0cb9..f21cb25742d 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.operations.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.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/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html index 71c5b894380..041fafc9567 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html @@ -1165,7 +1165,7 @@

Method Details

], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. - "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. + "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. "mediaInfo": { # Media-specific user event information. # Media-specific info. "mediaProgressDuration": "A String", # The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be set to 90. @@ -1467,7 +1467,7 @@

Method Details

"imageBytes": "A String", # Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP. }, "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. - "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. + "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored. "A String", ], @@ -1501,7 +1501,7 @@

Method Details

}, "relevanceThreshold": "A String", # The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search. "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search. - "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. This field is only supported for search requests. + "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. This field is only supported for search requests. "disableGenerativeAnswerAddOn": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers. "disableKpiPersonalizationAddOn": True or False, # Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results. "disableSemanticAddOn": True or False, # Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream. @@ -2088,7 +2088,7 @@

Method Details

"imageBytes": "A String", # Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP. }, "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. - "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. + "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored. "A String", ], @@ -2122,7 +2122,7 @@

Method Details

}, "relevanceThreshold": "A String", # The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search. "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search. - "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. This field is only supported for search requests. + "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. This field is only supported for search requests. "disableGenerativeAnswerAddOn": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers. "disableKpiPersonalizationAddOn": True or False, # Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results. "disableSemanticAddOn": True or False, # Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.userEvents.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.userEvents.html index c9fe42fcd43..aed1ccc85ed 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.userEvents.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.userEvents.html @@ -190,7 +190,7 @@

Method Details

], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. - "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. + "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. "mediaInfo": { # Media-specific user event information. # Media-specific info. "mediaProgressDuration": "A String", # The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be set to 90. @@ -388,7 +388,7 @@

Method Details

], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. - "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. + "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. "mediaInfo": { # Media-specific user event information. # Media-specific info. "mediaProgressDuration": "A String", # The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be set to 90. @@ -511,7 +511,7 @@

Method Details

], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. - "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. + "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. "mediaInfo": { # Media-specific user event information. # Media-specific info. "mediaProgressDuration": "A String", # The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be set to 90. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html index 95571f8e2af..cd4733c7d13 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html @@ -277,7 +277,7 @@

Method Details

"imageBytes": "A String", # Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP. }, "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. - "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. + "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored. "A String", ], @@ -311,7 +311,7 @@

Method Details

}, "relevanceThreshold": "A String", # The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search. "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search. - "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. This field is only supported for search requests. + "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. This field is only supported for search requests. "disableGenerativeAnswerAddOn": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers. "disableKpiPersonalizationAddOn": True or False, # Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results. "disableSemanticAddOn": True or False, # Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream. @@ -580,7 +580,7 @@

Method Details

"imageBytes": "A String", # Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP. }, "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. - "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. + "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored. "A String", ], @@ -614,7 +614,7 @@

Method Details

}, "relevanceThreshold": "A String", # The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search. "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search. - "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. This field is only supported for search requests. + "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. This field is only supported for search requests. "disableGenerativeAnswerAddOn": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers. "disableKpiPersonalizationAddOn": True or False, # Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results. "disableSemanticAddOn": True or False, # Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream. @@ -859,7 +859,7 @@

Method Details

"imageBytes": "A String", # Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP. }, "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. - "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. + "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored. "A String", ], @@ -893,7 +893,7 @@

Method Details

}, "relevanceThreshold": "A String", # The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search. "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search. - "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. This field is only supported for search requests. + "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. This field is only supported for search requests. "disableGenerativeAnswerAddOn": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers. "disableKpiPersonalizationAddOn": True or False, # Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results. "disableSemanticAddOn": True or False, # Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.identityMappingStores.operations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.identityMappingStores.operations.html index 2440d68d55f..a23d1f26aaa 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.identityMappingStores.operations.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.identityMappingStores.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/discoveryengine_v1beta.projects.locations.operations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.operations.html index b84aa0b06a6..955751ec1bc 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.operations.html +++ b/docs/dyn/discoveryengine_v1beta.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/discoveryengine_v1beta.projects.locations.userEvents.html b/docs/dyn/discoveryengine_v1beta.projects.locations.userEvents.html index d6f8a8ad3e4..5c801e3b4db 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.userEvents.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.userEvents.html @@ -187,7 +187,7 @@

Method Details

], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. - "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. + "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. "mediaInfo": { # Media-specific user event information. # Media-specific info. "mediaProgressDuration": "A String", # The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be set to 90. @@ -342,7 +342,7 @@

Method Details

], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. - "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. + "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. "mediaInfo": { # Media-specific user event information. # Media-specific info. "mediaProgressDuration": "A String", # The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be set to 90. @@ -465,7 +465,7 @@

Method Details

], "engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. "eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. - "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. + "eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. "mediaInfo": { # Media-specific user event information. # Media-specific info. "mediaProgressDuration": "A String", # The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be set to 90. diff --git a/docs/dyn/discoveryengine_v1beta.projects.operations.html b/docs/dyn/discoveryengine_v1beta.projects.operations.html index 4b910f292b9..6578fac4c06 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.operations.html +++ b/docs/dyn/discoveryengine_v1beta.projects.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/discoveryengine.v1.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json index ddf793fd360..83470b039e8 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json @@ -649,6 +649,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", @@ -1288,6 +1293,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", @@ -1836,6 +1846,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", @@ -1908,6 +1923,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", @@ -2134,6 +2154,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", @@ -2734,6 +2759,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", @@ -3066,6 +3096,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", @@ -4002,6 +4037,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", @@ -4450,6 +4490,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", @@ -5061,6 +5106,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", @@ -5580,6 +5630,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", @@ -5652,6 +5707,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", @@ -7059,6 +7119,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", @@ -7131,6 +7196,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", @@ -7481,6 +7551,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", @@ -7496,7 +7571,7 @@ } } }, -"revision": "20250918", +"revision": "20250924", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GdataBlobstore2Info": { @@ -8366,7 +8441,7 @@ "description": "Properties of the object.", "type": "any" }, -"description": "Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client ID for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server.", +"description": "Optional. Action parameters in structured json format.", "type": "object" }, "isActionConfigured": { @@ -8374,6 +8449,10 @@ "readOnly": true, "type": "boolean" }, +"jsonActionParams": { +"description": "Optional. Action parameters in json string format.", +"type": "string" +}, "serviceName": { "description": "Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled.", "type": "string" @@ -10536,6 +10615,13 @@ "description": "The configuration for the BAP connector.", "id": "GoogleCloudDiscoveryengineV1BAPConfig", "properties": { +"enabledActions": { +"description": "Optional. The actions enabled on the associated BAP connection.", +"items": { +"type": "string" +}, +"type": "array" +}, "supportedConnectorModes": { "description": "Required. The supported connector modes for the associated BAP connection.", "items": { @@ -11341,7 +11427,8 @@ "DELETE_FAILED", "UNUSABLE", "ACTIVE_ROTATING", -"DELETED" +"DELETED", +"EXPIRED" ], "enumDescriptions": [ "The CmekConfig state is unknown.", @@ -11352,7 +11439,8 @@ "The CmekConfig deletion process failed.", "The CmekConfig is not usable, most likely due to some internal issue.", "The KMS key version is being rotated.", -"The KMS key is soft deleted. Some cleanup policy will eventually be applied." +"The KMS key is soft deleted. Some cleanup policy will eventually be applied.", +"The KMS key is expired, meaning the key has been disabled for 30+ days. The customer can call DeleteCmekConfig to change the state to DELETED." ], "readOnly": true, "type": "string" @@ -12459,6 +12547,10 @@ "description": "Optional. Any authentication parameters specific to EUA connectors.", "type": "object" }, +"jsonAuthParams": { +"description": "Optional. Any authentication parameters specific to EUA connectors in json string format.", +"type": "string" +}, "tenant": { "$ref": "GoogleCloudDiscoveryengineV1Tenant", "description": "Optional. The tenant project the connector is connected to." @@ -12483,8 +12575,12 @@ "description": "Properties of the object.", "type": "any" }, -"description": "Optional. Any authentication parameters specific to FEDERATED.", +"description": "Optional. Any authentication parameters specific to FEDERATED connectors.", "type": "object" +}, +"jsonAuthParams": { +"description": "Optional. Any authentication parameters specific to FEDERATED connectors in json string format.", +"type": "string" } }, "type": "object" @@ -12600,6 +12696,20 @@ "description": "Output only. CMEK-related information for the DataStore.", "readOnly": true }, +"configurableBillingApproach": { +"description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search.", +"enum": [ +"CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", +"CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE", +"CONFIGURABLE_CONSUMPTION_EMBEDDING" +], +"enumDescriptions": [ +"Default value. For Spark and non-Spark non-configurable billing approach.", +"Use the subscription base + overage billing for indexing core for non embedding storage.", +"Use the consumption pay-as-you-go billing for embedding storage add-on." +], +"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": [ @@ -13411,7 +13521,7 @@ ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation` * `disable-onedrive-upload`", "type": "object" }, "industryVertical": { @@ -15550,6 +15660,10 @@ "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.", "type": "string" }, +"naturalLanguageQueryUnderstandingSpec": { +"$ref": "GoogleCloudDiscoveryengineV1SearchRequestNaturalLanguageQueryUnderstandingSpec", +"description": "Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." +}, "offset": { "description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.", "format": "int32", @@ -16077,6 +16191,55 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1SearchRequestNaturalLanguageQueryUnderstandingSpec": { +"description": "Specification to enable natural language understanding capabilities for search requests.", +"id": "GoogleCloudDiscoveryengineV1SearchRequestNaturalLanguageQueryUnderstandingSpec", +"properties": { +"allowedFieldNames": { +"description": "Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.", +"items": { +"type": "string" +}, +"type": "array" +}, +"extractedFilterBehavior": { +"description": "Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.", +"enum": [ +"EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED", +"HARD_FILTER", +"SOFT_BOOST" +], +"enumDescriptions": [ +"`EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED` will use the default behavior for extracted filters. For single datastore search, the default is to apply as hard filters. For multi-datastore search, the default is to apply as soft boosts.", +"Applies all extracted filters as hard filters on the results. Results that do not pass the extracted filters will not be returned in the result set.", +"Applies all extracted filters as soft boosts. Results that pass the filters will be boosted up to higher ranks in the result set." +], +"type": "string" +}, +"filterExtractionCondition": { +"description": "The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`.", +"enum": [ +"CONDITION_UNSPECIFIED", +"DISABLED", +"ENABLED" +], +"enumDescriptions": [ +"Server behavior defaults to `DISABLED`.", +"Disables NL filter extraction.", +"Enables NL filter extraction." +], +"type": "string" +}, +"geoSearchQueryDetectionFieldNames": { +"description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1SearchRequestQueryExpansionSpec": { "description": "Specification to determine under which conditions query expansion should occur.", "id": "GoogleCloudDiscoveryengineV1SearchRequestQueryExpansionSpec", @@ -17497,7 +17660,7 @@ false "type": "string" }, "eventType": { -"description": "Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event.", +"description": "Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event.", "type": "string" }, "filter": { @@ -17706,7 +17869,7 @@ false "description": "Properties of the object.", "type": "any" }, -"description": "Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client ID for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server.", +"description": "Optional. Action parameters in structured json format.", "type": "object" }, "isActionConfigured": { @@ -17714,6 +17877,10 @@ false "readOnly": true, "type": "boolean" }, +"jsonActionParams": { +"description": "Optional. Action parameters in json string format.", +"type": "string" +}, "serviceName": { "description": "Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled.", "type": "string" @@ -18411,6 +18578,13 @@ false "description": "The configuration for the BAP connector.", "id": "GoogleCloudDiscoveryengineV1alphaBAPConfig", "properties": { +"enabledActions": { +"description": "Optional. The actions enabled on the associated BAP connection.", +"items": { +"type": "string" +}, +"type": "array" +}, "supportedConnectorModes": { "description": "Required. The supported connector modes for the associated BAP connection.", "items": { @@ -18575,7 +18749,8 @@ false "DELETE_FAILED", "UNUSABLE", "ACTIVE_ROTATING", -"DELETED" +"DELETED", +"EXPIRED" ], "enumDescriptions": [ "The CmekConfig state is unknown.", @@ -18586,7 +18761,8 @@ false "The CmekConfig deletion process failed.", "The CmekConfig is not usable, most likely due to some internal issue.", "The KMS key version is being rotated.", -"The KMS key is soft deleted. Some cleanup policy will eventually be applied." +"The KMS key is soft deleted. Some cleanup policy will eventually be applied.", +"The KMS key is expired, meaning the key has been disabled for 30+ days. The customer can call DeleteCmekConfig to change the state to DELETED." ], "readOnly": true, "type": "string" @@ -19602,6 +19778,10 @@ false "description": "Optional. Any authentication parameters specific to EUA connectors.", "type": "object" }, +"jsonAuthParams": { +"description": "Optional. Any authentication parameters specific to EUA connectors in json string format.", +"type": "string" +}, "tenant": { "$ref": "GoogleCloudDiscoveryengineV1alphaTenant", "description": "Optional. The tenant project the connector is connected to." @@ -19626,8 +19806,12 @@ false "description": "Properties of the object.", "type": "any" }, -"description": "Optional. Any authentication parameters specific to FEDERATED.", +"description": "Optional. Any authentication parameters specific to FEDERATED connectors.", "type": "object" +}, +"jsonAuthParams": { +"description": "Optional. Any authentication parameters specific to FEDERATED connectors in json string format.", +"type": "string" } }, "type": "object" @@ -19743,6 +19927,20 @@ false "description": "Output only. CMEK-related information for the DataStore.", "readOnly": true }, +"configurableBillingApproach": { +"description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search.", +"enum": [ +"CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", +"CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE", +"CONFIGURABLE_CONSUMPTION_EMBEDDING" +], +"enumDescriptions": [ +"Default value. For Spark and non-Spark non-configurable billing approach.", +"Use the subscription base + overage billing for indexing core for non embedding storage.", +"Use the consumption pay-as-you-go billing for embedding storage add-on." +], +"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": [ @@ -20395,7 +20593,7 @@ false ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation` * `disable-onedrive-upload`", "type": "object" }, "industryVertical": { @@ -22307,7 +22505,7 @@ false }, "naturalLanguageQueryUnderstandingSpec": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec", -"description": "Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." +"description": "Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." }, "offset": { "description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.", @@ -22412,7 +22610,7 @@ false }, "searchAddonSpec": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec", -"description": "Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. This field is only supported for search requests." +"description": "Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. This field is only supported for search requests." }, "searchAsYouTypeSpec": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec", @@ -23023,7 +23221,7 @@ false "type": "object" }, "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec": { -"description": "SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable.", +"description": "SearchAddonSpec is used to disable add-ons for search as per new repricing model. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable.", "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec", "properties": { "disableGenerativeAnswerAddOn": { @@ -23886,7 +24084,8 @@ false "DELETE_FAILED", "UNUSABLE", "ACTIVE_ROTATING", -"DELETED" +"DELETED", +"EXPIRED" ], "enumDescriptions": [ "The CmekConfig state is unknown.", @@ -23897,7 +24096,8 @@ false "The CmekConfig deletion process failed.", "The CmekConfig is not usable, most likely due to some internal issue.", "The KMS key version is being rotated.", -"The KMS key is soft deleted. Some cleanup policy will eventually be applied." +"The KMS key is soft deleted. Some cleanup policy will eventually be applied.", +"The KMS key is expired, meaning the key has been disabled for 30+ days. The customer can call DeleteCmekConfig to change the state to DELETED." ], "readOnly": true, "type": "string" @@ -24316,6 +24516,20 @@ false "description": "Output only. CMEK-related information for the DataStore.", "readOnly": true }, +"configurableBillingApproach": { +"description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search.", +"enum": [ +"CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", +"CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE", +"CONFIGURABLE_CONSUMPTION_EMBEDDING" +], +"enumDescriptions": [ +"Default value. For Spark and non-Spark non-configurable billing approach.", +"Use the subscription base + overage billing for indexing core for non embedding storage.", +"Use the consumption pay-as-you-go billing for embedding storage add-on." +], +"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": [ @@ -24872,7 +25086,7 @@ false ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation` * `disable-onedrive-upload`", "type": "object" }, "industryVertical": { @@ -26087,7 +26301,7 @@ false }, "naturalLanguageQueryUnderstandingSpec": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec", -"description": "Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." +"description": "Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." }, "offset": { "description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.", @@ -26192,7 +26406,7 @@ false }, "searchAddonSpec": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAddonSpec", -"description": "Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. This field is only supported for search requests." +"description": "Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. This field is only supported for search requests." }, "searchAsYouTypeSpec": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec", @@ -26799,7 +27013,7 @@ false "type": "object" }, "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAddonSpec": { -"description": "SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable.", +"description": "SearchAddonSpec is used to disable add-ons for search as per new repricing model. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable.", "id": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAddonSpec", "properties": { "disableGenerativeAnswerAddOn": { @@ -27331,6 +27545,13 @@ false "$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" diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json index 2ed5323659c..b285c2976cb 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json @@ -891,7 +891,7 @@ "dataConnector": { "methods": { "acquireAccessToken": { -"description": "Uses the per-user refresh token minted with AcquireAndStoreRefreshToken to generate and return a new access token and its details. Takes the access token from cache if available. Rotates the stored refresh token if needed. Uses the end user identity to return the user specific access token. Does *not* return the credentials configured by the administrator. Used by Agentspace action execution and Agentspace UI.", +"description": "Uses the per-user refresh token minted with AcquireAndStoreRefreshToken to generate and return a new access token and its details. Takes the access token from cache if available. Rotates the stored refresh token if needed. Uses the end user identity to return the user specific access token. Does *not* return the credentials configured by the administrator. Used by action execution and UI.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector:acquireAccessToken", "httpMethod": "POST", "id": "discoveryengine.projects.locations.collections.dataConnector.acquireAccessToken", @@ -1071,6 +1071,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": "v1alpha/{+name}/operations", @@ -1462,6 +1467,86 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"get": { +"description": "Retrieves a Branch.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.collections.dataStores.branches.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the branch to retrieve. Format: `projects/*/locations/global/dataStores/default_data_store/branches/some_branch_id`. \"default_branch\" can be used as a special branch_id, it returns the default branch that has been set for the document.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+$", +"required": true, +"type": "string" +}, +"view": { +"description": "The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified.", +"enum": [ +"BRANCH_VIEW_UNSPECIFIED", +"BRANCH_VIEW_BASIC", +"BRANCH_VIEW_FULL" +], +"enumDescriptions": [ +"The value when it's unspecified. This defaults to the BASIC view.", +"Includes basic metadata about the branch, but not statistical fields. See documentation of individual fields of Branch to know what is excluded.", +"Includes all fields of a Branch." +], +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaBranch" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists all Branchs under the specified parent DataStore.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.collections.dataStores.branches.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent data store resource name.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", +"required": true, +"type": "string" +}, +"view": { +"description": "The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified.", +"enum": [ +"BRANCH_VIEW_UNSPECIFIED", +"BRANCH_VIEW_BASIC", +"BRANCH_VIEW_FULL" +], +"enumDescriptions": [ +"The value when it's unspecified. This defaults to the BASIC view.", +"Includes basic metadata about the branch, but not statistical fields. See documentation of individual fields of Branch to know what is excluded.", +"Includes all fields of a Branch." +], +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+parent}/branches", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaListBranchesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } }, "resources": { @@ -1898,6 +1983,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": "v1alpha/{+name}/operations", @@ -2446,6 +2536,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": "v1alpha/{+name}/operations", @@ -2518,6 +2613,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": "v1alpha/{+name}/operations", @@ -2744,6 +2844,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": "v1alpha/{+name}/operations", @@ -3458,6 +3563,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": "v1alpha/{+name}/operations", @@ -3790,6 +3900,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": "v1alpha/{+name}/operations", @@ -4881,6 +4996,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": "v1alpha/{+name}/operations", @@ -5479,6 +5599,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": "v1alpha/{+name}/operations", @@ -5842,6 +5967,86 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"get": { +"description": "Retrieves a Branch.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.dataStores.branches.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the branch to retrieve. Format: `projects/*/locations/global/dataStores/default_data_store/branches/some_branch_id`. \"default_branch\" can be used as a special branch_id, it returns the default branch that has been set for the document.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$", +"required": true, +"type": "string" +}, +"view": { +"description": "The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified.", +"enum": [ +"BRANCH_VIEW_UNSPECIFIED", +"BRANCH_VIEW_BASIC", +"BRANCH_VIEW_FULL" +], +"enumDescriptions": [ +"The value when it's unspecified. This defaults to the BASIC view.", +"Includes basic metadata about the branch, but not statistical fields. See documentation of individual fields of Branch to know what is excluded.", +"Includes all fields of a Branch." +], +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaBranch" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists all Branchs under the specified parent DataStore.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.dataStores.branches.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent data store resource name.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", +"required": true, +"type": "string" +}, +"view": { +"description": "The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified.", +"enum": [ +"BRANCH_VIEW_UNSPECIFIED", +"BRANCH_VIEW_BASIC", +"BRANCH_VIEW_FULL" +], +"enumDescriptions": [ +"The value when it's unspecified. This defaults to the BASIC view.", +"Includes basic metadata about the branch, but not statistical fields. See documentation of individual fields of Branch to know what is excluded.", +"Includes all fields of a Branch." +], +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+parent}/branches", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaListBranchesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } }, "resources": { @@ -6278,6 +6483,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": "v1alpha/{+name}/operations", @@ -6797,6 +7007,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": "v1alpha/{+name}/operations", @@ -6869,6 +7084,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": "v1alpha/{+name}/operations", @@ -8536,6 +8756,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": "v1alpha/{+name}/operations", @@ -8936,6 +9161,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": "v1alpha/{+name}/operations", @@ -9614,6 +9844,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": "v1alpha/{+name}/operations", @@ -9733,6 +9968,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": "v1alpha/{+name}/operations", @@ -9748,7 +9988,7 @@ } } }, -"revision": "20250918", +"revision": "20250924", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "ApiservingMediaRequestInfo": { @@ -10785,7 +11025,7 @@ "description": "Properties of the object.", "type": "any" }, -"description": "Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client ID for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server.", +"description": "Optional. Action parameters in structured json format.", "type": "object" }, "isActionConfigured": { @@ -10793,6 +11033,10 @@ "readOnly": true, "type": "boolean" }, +"jsonActionParams": { +"description": "Optional. Action parameters in json string format.", +"type": "string" +}, "serviceName": { "description": "Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled.", "type": "string" @@ -11093,6 +11337,13 @@ "description": "The configuration for the BAP connector.", "id": "GoogleCloudDiscoveryengineV1BAPConfig", "properties": { +"enabledActions": { +"description": "Optional. The actions enabled on the associated BAP connection.", +"items": { +"type": "string" +}, +"type": "array" +}, "supportedConnectorModes": { "description": "Required. The supported connector modes for the associated BAP connection.", "items": { @@ -11257,7 +11508,8 @@ "DELETE_FAILED", "UNUSABLE", "ACTIVE_ROTATING", -"DELETED" +"DELETED", +"EXPIRED" ], "enumDescriptions": [ "The CmekConfig state is unknown.", @@ -11268,7 +11520,8 @@ "The CmekConfig deletion process failed.", "The CmekConfig is not usable, most likely due to some internal issue.", "The KMS key version is being rotated.", -"The KMS key is soft deleted. Some cleanup policy will eventually be applied." +"The KMS key is soft deleted. Some cleanup policy will eventually be applied.", +"The KMS key is expired, meaning the key has been disabled for 30+ days. The customer can call DeleteCmekConfig to change the state to DELETED." ], "readOnly": true, "type": "string" @@ -12027,6 +12280,10 @@ "description": "Optional. Any authentication parameters specific to EUA connectors.", "type": "object" }, +"jsonAuthParams": { +"description": "Optional. Any authentication parameters specific to EUA connectors in json string format.", +"type": "string" +}, "tenant": { "$ref": "GoogleCloudDiscoveryengineV1Tenant", "description": "Optional. The tenant project the connector is connected to." @@ -12051,8 +12308,12 @@ "description": "Properties of the object.", "type": "any" }, -"description": "Optional. Any authentication parameters specific to FEDERATED.", +"description": "Optional. Any authentication parameters specific to FEDERATED connectors.", "type": "object" +}, +"jsonAuthParams": { +"description": "Optional. Any authentication parameters specific to FEDERATED connectors in json string format.", +"type": "string" } }, "type": "object" @@ -12168,6 +12429,20 @@ "description": "Output only. CMEK-related information for the DataStore.", "readOnly": true }, +"configurableBillingApproach": { +"description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search.", +"enum": [ +"CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", +"CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE", +"CONFIGURABLE_CONSUMPTION_EMBEDDING" +], +"enumDescriptions": [ +"Default value. For Spark and non-Spark non-configurable billing approach.", +"Use the subscription base + overage billing for indexing core for non embedding storage.", +"Use the consumption pay-as-you-go billing for embedding storage add-on." +], +"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": [ @@ -12773,7 +13048,7 @@ ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation` * `disable-onedrive-upload`", "type": "object" }, "industryVertical": { @@ -14416,7 +14691,7 @@ "description": "Properties of the object.", "type": "any" }, -"description": "Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client ID for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server.", +"description": "Optional. Action parameters in structured json format.", "type": "object" }, "isActionConfigured": { @@ -14424,6 +14699,10 @@ "readOnly": true, "type": "boolean" }, +"jsonActionParams": { +"description": "Optional. Action parameters in json string format.", +"type": "string" +}, "serviceName": { "description": "Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled.", "type": "string" @@ -16275,6 +16554,11 @@ "groundedContent": { "$ref": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContent", "description": "Possibly grounded response text or media from the assistant." +}, +"replyId": { +"description": "Output only. When set, uniquely identifies a reply within the `AssistAnswer` resource. During an AssistantService.StreamAssist call, multiple `Reply` messages with the same ID can occur within the response stream (across multiple AssistantService.StreamAssistResponse messages). These represent parts of a single `Reply` message in the final `AssistAnswer` resource.", +"readOnly": true, +"type": "string" } }, "type": "object" @@ -16691,6 +16975,13 @@ "description": "The configuration for the BAP connector.", "id": "GoogleCloudDiscoveryengineV1alphaBAPConfig", "properties": { +"enabledActions": { +"description": "Optional. The actions enabled on the associated BAP connection.", +"items": { +"type": "string" +}, +"type": "array" +}, "supportedConnectorModes": { "description": "Required. The supported connector modes for the associated BAP connection.", "items": { @@ -17108,6 +17399,53 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaBranch": { +"description": "A data branch that stores Documents.", +"id": "GoogleCloudDiscoveryengineV1alphaBranch", +"properties": { +"branchStats": { +"$ref": "GoogleCloudDiscoveryengineV1alphaBranchBranchStats", +"description": "Output only. Stistics describing a branch. This field is not populated in BranchView.BASIC view.", +"readOnly": true +}, +"displayName": { +"description": "Output only. Human readable name of the branch to display in the UI.", +"readOnly": true, +"type": "string" +}, +"isDefault": { +"description": "Output only. Indicates whether this branch is set as the default branch of its parent data store.", +"readOnly": true, +"type": "boolean" +}, +"lastDocumentImportTime": { +"description": "Output only. Timestamp of last import through DocumentService.ImportDocuments. Empty value means no import has been made to this branch.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Immutable. Full resource name of the branch, such as `projects/*/locations/global/dataStores/data_store/branches/branch_id`.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaBranchBranchStats": { +"description": "Statistics describing a branch.", +"id": "GoogleCloudDiscoveryengineV1alphaBranchBranchStats", +"properties": { +"documentCounts": { +"additionalProperties": { +"format": "int64", +"type": "string" +}, +"description": "The number of documents in a given branch. The key is a group representing a set of documents, and the value is the number of document in that group. Note: keys in this map may change over time. Supported keys: ['all'].", +"type": "object" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest": { "description": "Request message for GroundedGenerationService.CheckGrounding method.", "id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest", @@ -17588,7 +17926,8 @@ "DELETE_FAILED", "UNUSABLE", "ACTIVE_ROTATING", -"DELETED" +"DELETED", +"EXPIRED" ], "enumDescriptions": [ "The CmekConfig state is unknown.", @@ -17599,7 +17938,8 @@ "The CmekConfig deletion process failed.", "The CmekConfig is not usable, most likely due to some internal issue.", "The KMS key version is being rotated.", -"The KMS key is soft deleted. Some cleanup policy will eventually be applied." +"The KMS key is soft deleted. Some cleanup policy will eventually be applied.", +"The KMS key is expired, meaning the key has been disabled for 30+ days. The customer can call DeleteCmekConfig to change the state to DELETED." ], "readOnly": true, "type": "string" @@ -18970,6 +19310,10 @@ "description": "Optional. Any authentication parameters specific to EUA connectors.", "type": "object" }, +"jsonAuthParams": { +"description": "Optional. Any authentication parameters specific to EUA connectors in json string format.", +"type": "string" +}, "tenant": { "$ref": "GoogleCloudDiscoveryengineV1alphaTenant", "description": "Optional. The tenant project the connector is connected to." @@ -18994,8 +19338,12 @@ "description": "Properties of the object.", "type": "any" }, -"description": "Optional. Any authentication parameters specific to FEDERATED.", +"description": "Optional. Any authentication parameters specific to FEDERATED connectors.", "type": "object" +}, +"jsonAuthParams": { +"description": "Optional. Any authentication parameters specific to FEDERATED connectors in json string format.", +"type": "string" } }, "type": "object" @@ -19111,6 +19459,20 @@ "description": "Output only. CMEK-related information for the DataStore.", "readOnly": true }, +"configurableBillingApproach": { +"description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search.", +"enum": [ +"CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", +"CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE", +"CONFIGURABLE_CONSUMPTION_EMBEDDING" +], +"enumDescriptions": [ +"Default value. For Spark and non-Spark non-configurable billing approach.", +"Use the subscription base + overage billing for indexing core for non embedding storage.", +"Use the consumption pay-as-you-go billing for embedding storage add-on." +], +"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": [ @@ -19980,7 +20342,7 @@ ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation` * `disable-onedrive-upload`", "type": "object" }, "industryVertical": { @@ -21847,6 +22209,20 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaListBranchesResponse": { +"description": "Response for BranchService.ListBranches method.", +"id": "GoogleCloudDiscoveryengineV1alphaListBranchesResponse", +"properties": { +"branches": { +"description": "The Branches.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaBranch" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaListChunksResponse": { "description": "Response message for ChunkService.ListChunks method.", "id": "GoogleCloudDiscoveryengineV1alphaListChunksResponse", @@ -23943,7 +24319,7 @@ }, "naturalLanguageQueryUnderstandingSpec": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec", -"description": "Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." +"description": "Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." }, "offset": { "description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.", @@ -24048,7 +24424,7 @@ false }, "searchAddonSpec": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec", -"description": "Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. This field is only supported for search requests." +"description": "Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. This field is only supported for search requests." }, "searchAsYouTypeSpec": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec", @@ -24659,7 +25035,7 @@ false "type": "object" }, "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec": { -"description": "SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable.", +"description": "SearchAddonSpec is used to disable add-ons for search as per new repricing model. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable.", "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec", "properties": { "disableGenerativeAnswerAddOn": { @@ -26698,7 +27074,7 @@ false "type": "string" }, "eventType": { -"description": "Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event.", +"description": "Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event.", "type": "string" }, "filter": { @@ -27553,7 +27929,7 @@ false ], "type": "string" }, -"description": "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-image-generation` * `disable-video-generation`", +"description": "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-image-generation` * `disable-video-generation` * `disable-onedrive-upload`", "readOnly": true, "type": "object" }, @@ -27872,7 +28248,8 @@ false "DELETE_FAILED", "UNUSABLE", "ACTIVE_ROTATING", -"DELETED" +"DELETED", +"EXPIRED" ], "enumDescriptions": [ "The CmekConfig state is unknown.", @@ -27883,7 +28260,8 @@ false "The CmekConfig deletion process failed.", "The CmekConfig is not usable, most likely due to some internal issue.", "The KMS key version is being rotated.", -"The KMS key is soft deleted. Some cleanup policy will eventually be applied." +"The KMS key is soft deleted. Some cleanup policy will eventually be applied.", +"The KMS key is expired, meaning the key has been disabled for 30+ days. The customer can call DeleteCmekConfig to change the state to DELETED." ], "readOnly": true, "type": "string" @@ -28302,6 +28680,20 @@ false "description": "Output only. CMEK-related information for the DataStore.", "readOnly": true }, +"configurableBillingApproach": { +"description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search.", +"enum": [ +"CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", +"CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE", +"CONFIGURABLE_CONSUMPTION_EMBEDDING" +], +"enumDescriptions": [ +"Default value. For Spark and non-Spark non-configurable billing approach.", +"Use the subscription base + overage billing for indexing core for non embedding storage.", +"Use the consumption pay-as-you-go billing for embedding storage add-on." +], +"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": [ @@ -28858,7 +29250,7 @@ false ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation` * `disable-onedrive-upload`", "type": "object" }, "industryVertical": { @@ -30073,7 +30465,7 @@ false }, "naturalLanguageQueryUnderstandingSpec": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec", -"description": "Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." +"description": "Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." }, "offset": { "description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.", @@ -30178,7 +30570,7 @@ false }, "searchAddonSpec": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAddonSpec", -"description": "Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. This field is only supported for search requests." +"description": "Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. This field is only supported for search requests." }, "searchAsYouTypeSpec": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec", @@ -30785,7 +31177,7 @@ false "type": "object" }, "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAddonSpec": { -"description": "SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable.", +"description": "SearchAddonSpec is used to disable add-ons for search as per new repricing model. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable.", "id": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAddonSpec", "properties": { "disableGenerativeAnswerAddOn": { @@ -32015,15 +32407,15 @@ false "id": "GoogleCloudNotebooklmV1alphaUserContentAgentspaceContent", "properties": { "documentName": { -"description": "Optional. The full document name in Agentspace.", +"description": "Optional. The full resource name of the Agentspace document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`.", "type": "string" }, "engineName": { -"description": "Optional. Engine to verify the permission of the document.", +"description": "Optional. Engine to verify the permission of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`.", "type": "string" }, "ideaforgeIdeaName": { -"description": "Optional. The full idea name for IdeaForge.", +"description": "Optional. Resource name of the idea forge instance. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/ideaForgeInstances/{instance}`", "type": "string" } }, @@ -32126,6 +32518,13 @@ false "$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" diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json index f4740c21c07..b7227ff14d0 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json @@ -581,6 +581,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", @@ -1220,6 +1225,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", @@ -1768,6 +1778,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", @@ -1840,6 +1855,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", @@ -2066,6 +2086,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", @@ -2727,6 +2752,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", @@ -3059,6 +3089,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", @@ -4079,6 +4114,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", @@ -4588,6 +4628,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", @@ -5199,6 +5244,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", @@ -5718,6 +5768,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", @@ -5790,6 +5845,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", @@ -7418,6 +7478,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", @@ -7490,6 +7555,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", @@ -8185,6 +8255,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", @@ -8200,7 +8275,7 @@ } } }, -"revision": "20250918", +"revision": "20250924", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GdataBlobstore2Info": { @@ -9070,7 +9145,7 @@ "description": "Properties of the object.", "type": "any" }, -"description": "Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client ID for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server.", +"description": "Optional. Action parameters in structured json format.", "type": "object" }, "isActionConfigured": { @@ -9078,6 +9153,10 @@ "readOnly": true, "type": "boolean" }, +"jsonActionParams": { +"description": "Optional. Action parameters in json string format.", +"type": "string" +}, "serviceName": { "description": "Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled.", "type": "string" @@ -9378,6 +9457,13 @@ "description": "The configuration for the BAP connector.", "id": "GoogleCloudDiscoveryengineV1BAPConfig", "properties": { +"enabledActions": { +"description": "Optional. The actions enabled on the associated BAP connection.", +"items": { +"type": "string" +}, +"type": "array" +}, "supportedConnectorModes": { "description": "Required. The supported connector modes for the associated BAP connection.", "items": { @@ -9542,7 +9628,8 @@ "DELETE_FAILED", "UNUSABLE", "ACTIVE_ROTATING", -"DELETED" +"DELETED", +"EXPIRED" ], "enumDescriptions": [ "The CmekConfig state is unknown.", @@ -9553,7 +9640,8 @@ "The CmekConfig deletion process failed.", "The CmekConfig is not usable, most likely due to some internal issue.", "The KMS key version is being rotated.", -"The KMS key is soft deleted. Some cleanup policy will eventually be applied." +"The KMS key is soft deleted. Some cleanup policy will eventually be applied.", +"The KMS key is expired, meaning the key has been disabled for 30+ days. The customer can call DeleteCmekConfig to change the state to DELETED." ], "readOnly": true, "type": "string" @@ -10312,6 +10400,10 @@ "description": "Optional. Any authentication parameters specific to EUA connectors.", "type": "object" }, +"jsonAuthParams": { +"description": "Optional. Any authentication parameters specific to EUA connectors in json string format.", +"type": "string" +}, "tenant": { "$ref": "GoogleCloudDiscoveryengineV1Tenant", "description": "Optional. The tenant project the connector is connected to." @@ -10336,8 +10428,12 @@ "description": "Properties of the object.", "type": "any" }, -"description": "Optional. Any authentication parameters specific to FEDERATED.", +"description": "Optional. Any authentication parameters specific to FEDERATED connectors.", "type": "object" +}, +"jsonAuthParams": { +"description": "Optional. Any authentication parameters specific to FEDERATED connectors in json string format.", +"type": "string" } }, "type": "object" @@ -10453,6 +10549,20 @@ "description": "Output only. CMEK-related information for the DataStore.", "readOnly": true }, +"configurableBillingApproach": { +"description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search.", +"enum": [ +"CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", +"CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE", +"CONFIGURABLE_CONSUMPTION_EMBEDDING" +], +"enumDescriptions": [ +"Default value. For Spark and non-Spark non-configurable billing approach.", +"Use the subscription base + overage billing for indexing core for non embedding storage.", +"Use the consumption pay-as-you-go billing for embedding storage add-on." +], +"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": [ @@ -11058,7 +11168,7 @@ ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation` * `disable-onedrive-upload`", "type": "object" }, "industryVertical": { @@ -12680,7 +12790,7 @@ "description": "Properties of the object.", "type": "any" }, -"description": "Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client ID for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server.", +"description": "Optional. Action parameters in structured json format.", "type": "object" }, "isActionConfigured": { @@ -12688,6 +12798,10 @@ "readOnly": true, "type": "boolean" }, +"jsonActionParams": { +"description": "Optional. Action parameters in json string format.", +"type": "string" +}, "serviceName": { "description": "Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled.", "type": "string" @@ -13385,6 +13499,13 @@ "description": "The configuration for the BAP connector.", "id": "GoogleCloudDiscoveryengineV1alphaBAPConfig", "properties": { +"enabledActions": { +"description": "Optional. The actions enabled on the associated BAP connection.", +"items": { +"type": "string" +}, +"type": "array" +}, "supportedConnectorModes": { "description": "Required. The supported connector modes for the associated BAP connection.", "items": { @@ -13549,7 +13670,8 @@ "DELETE_FAILED", "UNUSABLE", "ACTIVE_ROTATING", -"DELETED" +"DELETED", +"EXPIRED" ], "enumDescriptions": [ "The CmekConfig state is unknown.", @@ -13560,7 +13682,8 @@ "The CmekConfig deletion process failed.", "The CmekConfig is not usable, most likely due to some internal issue.", "The KMS key version is being rotated.", -"The KMS key is soft deleted. Some cleanup policy will eventually be applied." +"The KMS key is soft deleted. Some cleanup policy will eventually be applied.", +"The KMS key is expired, meaning the key has been disabled for 30+ days. The customer can call DeleteCmekConfig to change the state to DELETED." ], "readOnly": true, "type": "string" @@ -14576,6 +14699,10 @@ "description": "Optional. Any authentication parameters specific to EUA connectors.", "type": "object" }, +"jsonAuthParams": { +"description": "Optional. Any authentication parameters specific to EUA connectors in json string format.", +"type": "string" +}, "tenant": { "$ref": "GoogleCloudDiscoveryengineV1alphaTenant", "description": "Optional. The tenant project the connector is connected to." @@ -14600,8 +14727,12 @@ "description": "Properties of the object.", "type": "any" }, -"description": "Optional. Any authentication parameters specific to FEDERATED.", +"description": "Optional. Any authentication parameters specific to FEDERATED connectors.", "type": "object" +}, +"jsonAuthParams": { +"description": "Optional. Any authentication parameters specific to FEDERATED connectors in json string format.", +"type": "string" } }, "type": "object" @@ -14717,6 +14848,20 @@ "description": "Output only. CMEK-related information for the DataStore.", "readOnly": true }, +"configurableBillingApproach": { +"description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search.", +"enum": [ +"CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", +"CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE", +"CONFIGURABLE_CONSUMPTION_EMBEDDING" +], +"enumDescriptions": [ +"Default value. For Spark and non-Spark non-configurable billing approach.", +"Use the subscription base + overage billing for indexing core for non embedding storage.", +"Use the consumption pay-as-you-go billing for embedding storage add-on." +], +"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": [ @@ -15369,7 +15514,7 @@ ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation` * `disable-onedrive-upload`", "type": "object" }, "industryVertical": { @@ -17281,7 +17426,7 @@ }, "naturalLanguageQueryUnderstandingSpec": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec", -"description": "Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." +"description": "Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." }, "offset": { "description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.", @@ -17386,7 +17531,7 @@ false }, "searchAddonSpec": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec", -"description": "Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. This field is only supported for search requests." +"description": "Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. This field is only supported for search requests." }, "searchAsYouTypeSpec": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec", @@ -17997,7 +18142,7 @@ false "type": "object" }, "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec": { -"description": "SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable.", +"description": "SearchAddonSpec is used to disable add-ons for search as per new repricing model. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable.", "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec", "properties": { "disableGenerativeAnswerAddOn": { @@ -21691,7 +21836,8 @@ false "DELETE_FAILED", "UNUSABLE", "ACTIVE_ROTATING", -"DELETED" +"DELETED", +"EXPIRED" ], "enumDescriptions": [ "The CmekConfig state is unknown.", @@ -21702,7 +21848,8 @@ false "The CmekConfig deletion process failed.", "The CmekConfig is not usable, most likely due to some internal issue.", "The KMS key version is being rotated.", -"The KMS key is soft deleted. Some cleanup policy will eventually be applied." +"The KMS key is soft deleted. Some cleanup policy will eventually be applied.", +"The KMS key is expired, meaning the key has been disabled for 30+ days. The customer can call DeleteCmekConfig to change the state to DELETED." ], "readOnly": true, "type": "string" @@ -22476,6 +22623,20 @@ false "description": "Output only. CMEK-related information for the DataStore.", "readOnly": true }, +"configurableBillingApproach": { +"description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details, only apply to non-Spark UCS Search.", +"enum": [ +"CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED", +"CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE", +"CONFIGURABLE_CONSUMPTION_EMBEDDING" +], +"enumDescriptions": [ +"Default value. For Spark and non-Spark non-configurable billing approach.", +"Use the subscription base + overage billing for indexing core for non embedding storage.", +"Use the consumption pay-as-you-go billing for embedding storage add-on." +], +"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": [ @@ -23249,7 +23410,7 @@ false ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `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-image-generation` * `disable-video-generation` * `disable-onedrive-upload`", "type": "object" }, "industryVertical": { @@ -26015,7 +26176,7 @@ false }, "naturalLanguageQueryUnderstandingSpec": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec", -"description": "Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." +"description": "Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." }, "offset": { "description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.", @@ -26120,7 +26281,7 @@ false }, "searchAddonSpec": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAddonSpec", -"description": "Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. This field is only supported for search requests." +"description": "Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. This field is only supported for search requests." }, "searchAsYouTypeSpec": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec", @@ -26727,7 +26888,7 @@ false "type": "object" }, "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAddonSpec": { -"description": "SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable.", +"description": "SearchAddonSpec is used to disable add-ons for search as per new repricing model. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable.", "id": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAddonSpec", "properties": { "disableGenerativeAnswerAddOn": { @@ -28547,7 +28708,7 @@ false "type": "string" }, "eventType": { -"description": "Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event.", +"description": "Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event.", "type": "string" }, "filter": { @@ -28752,6 +28913,13 @@ false "$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 2cd4dd1c084fd3b9185549f84d2dd1d7b10ff9a6 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 30 Sep 2025 07:09:36 +0000 Subject: [PATCH 18/42] feat(dlp): update the api #### dlp:v2 The following keys were added: - schemas.GooglePrivacyDlpV2Action.properties.publishFindingsToDataplexCatalog.$ref (Total Keys: 1) - schemas.GooglePrivacyDlpV2PublishFindingsToDataplexCatalog (Total Keys: 2) --- .../dlp_v2.organizations.locations.dlpJobs.html | 4 ++++ ...p_v2.organizations.locations.jobTriggers.html | 12 ++++++++++++ docs/dyn/dlp_v2.projects.dlpJobs.html | 16 ++++++++++++++++ docs/dyn/dlp_v2.projects.jobTriggers.html | 16 ++++++++++++++++ docs/dyn/dlp_v2.projects.locations.dlpJobs.html | 16 ++++++++++++++++ .../dlp_v2.projects.locations.jobTriggers.html | 16 ++++++++++++++++ .../discovery_cache/documents/dlp.v2.json | 12 +++++++++++- 7 files changed, 91 insertions(+), 1 deletion(-) diff --git a/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html b/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html index 7550f20c69e..a0a0867f857 100644 --- a/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html +++ b/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html @@ -2764,6 +2764,8 @@

Method Details

}, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings to Cloud Datahub. }, + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. To learn more about aspects, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are persisted in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, "publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'. # Enable Stackdriver metric dlp.googleapis.com/finding_count. @@ -3550,6 +3552,8 @@

Method Details

}, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings to Cloud Datahub. }, + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. To learn more about aspects, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are persisted in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, "publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'. # Enable Stackdriver metric dlp.googleapis.com/finding_count. diff --git a/docs/dyn/dlp_v2.organizations.locations.jobTriggers.html b/docs/dyn/dlp_v2.organizations.locations.jobTriggers.html index 602e6809db7..e4869c91ca4 100644 --- a/docs/dyn/dlp_v2.organizations.locations.jobTriggers.html +++ b/docs/dyn/dlp_v2.organizations.locations.jobTriggers.html @@ -160,6 +160,8 @@

Method Details

}, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings to Cloud Datahub. }, + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. To learn more about aspects, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are persisted in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, "publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'. # Enable Stackdriver metric dlp.googleapis.com/finding_count. @@ -515,6 +517,8 @@

Method Details

}, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings to Cloud Datahub. }, + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. To learn more about aspects, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are persisted in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, "publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'. # Enable Stackdriver metric dlp.googleapis.com/finding_count. @@ -892,6 +896,8 @@

Method Details

}, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings to Cloud Datahub. }, + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. To learn more about aspects, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are persisted in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, "publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'. # Enable Stackdriver metric dlp.googleapis.com/finding_count. @@ -1263,6 +1269,8 @@

Method Details

}, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings to Cloud Datahub. }, + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. To learn more about aspects, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are persisted in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, "publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'. # Enable Stackdriver metric dlp.googleapis.com/finding_count. @@ -1635,6 +1643,8 @@

Method Details

}, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings to Cloud Datahub. }, + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. To learn more about aspects, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are persisted in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, "publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'. # Enable Stackdriver metric dlp.googleapis.com/finding_count. @@ -1989,6 +1999,8 @@

Method Details

}, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings to Cloud Datahub. }, + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. To learn more about aspects, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are persisted in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, "publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'. # Enable Stackdriver metric dlp.googleapis.com/finding_count. diff --git a/docs/dyn/dlp_v2.projects.dlpJobs.html b/docs/dyn/dlp_v2.projects.dlpJobs.html index d6cdab27328..a32416af14a 100644 --- a/docs/dyn/dlp_v2.projects.dlpJobs.html +++ b/docs/dyn/dlp_v2.projects.dlpJobs.html @@ -163,6 +163,8 @@

Method Details

}, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings to Cloud Datahub. }, + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. To learn more about aspects, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are persisted in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, "publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'. # Enable Stackdriver metric dlp.googleapis.com/finding_count. @@ -473,6 +475,8 @@

Method Details

}, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings to Cloud Datahub. }, + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. To learn more about aspects, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are persisted in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, "publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'. # Enable Stackdriver metric dlp.googleapis.com/finding_count. @@ -3271,6 +3275,8 @@

Method Details

}, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings to Cloud Datahub. }, + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. To learn more about aspects, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are persisted in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, "publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'. # Enable Stackdriver metric dlp.googleapis.com/finding_count. @@ -4057,6 +4063,8 @@

Method Details

}, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings to Cloud Datahub. }, + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. To learn more about aspects, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are persisted in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, "publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'. # Enable Stackdriver metric dlp.googleapis.com/finding_count. @@ -7004,6 +7012,8 @@

Method Details

}, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings to Cloud Datahub. }, + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. To learn more about aspects, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are persisted in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, "publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'. # Enable Stackdriver metric dlp.googleapis.com/finding_count. @@ -7790,6 +7800,8 @@

Method Details

}, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings to Cloud Datahub. }, + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. To learn more about aspects, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are persisted in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, "publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'. # Enable Stackdriver metric dlp.googleapis.com/finding_count. @@ -10731,6 +10743,8 @@

Method Details

}, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings to Cloud Datahub. }, + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. To learn more about aspects, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are persisted in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, "publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'. # Enable Stackdriver metric dlp.googleapis.com/finding_count. @@ -11517,6 +11531,8 @@

Method Details

}, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings to Cloud Datahub. }, + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. To learn more about aspects, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are persisted in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, "publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'. # Enable Stackdriver metric dlp.googleapis.com/finding_count. diff --git a/docs/dyn/dlp_v2.projects.jobTriggers.html b/docs/dyn/dlp_v2.projects.jobTriggers.html index 424725a5c8d..ecbba925ee4 100644 --- a/docs/dyn/dlp_v2.projects.jobTriggers.html +++ b/docs/dyn/dlp_v2.projects.jobTriggers.html @@ -2768,6 +2768,8 @@

Method Details

}, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings to Cloud Datahub. }, + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. To learn more about aspects, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are persisted in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, "publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'. # Enable Stackdriver metric dlp.googleapis.com/finding_count. @@ -3554,6 +3556,8 @@

Method Details

}, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings to Cloud Datahub. }, + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. To learn more about aspects, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are persisted in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, "publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'. # Enable Stackdriver metric dlp.googleapis.com/finding_count. @@ -3884,6 +3888,8 @@

Method Details

}, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings to Cloud Datahub. }, + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. To learn more about aspects, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are persisted in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, "publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'. # Enable Stackdriver metric dlp.googleapis.com/finding_count. @@ -4239,6 +4245,8 @@

Method Details

}, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings to Cloud Datahub. }, + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. To learn more about aspects, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are persisted in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, "publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'. # Enable Stackdriver metric dlp.googleapis.com/finding_count. @@ -4616,6 +4624,8 @@

Method Details

}, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings to Cloud Datahub. }, + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. To learn more about aspects, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are persisted in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, "publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'. # Enable Stackdriver metric dlp.googleapis.com/finding_count. @@ -4987,6 +4997,8 @@

Method Details

}, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings to Cloud Datahub. }, + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. To learn more about aspects, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are persisted in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, "publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'. # Enable Stackdriver metric dlp.googleapis.com/finding_count. @@ -5359,6 +5371,8 @@

Method Details

}, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings to Cloud Datahub. }, + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. To learn more about aspects, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are persisted in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, "publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'. # Enable Stackdriver metric dlp.googleapis.com/finding_count. @@ -5713,6 +5727,8 @@

Method Details

}, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings to Cloud Datahub. }, + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. To learn more about aspects, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are persisted in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, "publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'. # Enable Stackdriver metric dlp.googleapis.com/finding_count. diff --git a/docs/dyn/dlp_v2.projects.locations.dlpJobs.html b/docs/dyn/dlp_v2.projects.locations.dlpJobs.html index ba66f9c20c4..cdf077641c3 100644 --- a/docs/dyn/dlp_v2.projects.locations.dlpJobs.html +++ b/docs/dyn/dlp_v2.projects.locations.dlpJobs.html @@ -169,6 +169,8 @@

Method Details

}, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings to Cloud Datahub. }, + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. To learn more about aspects, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are persisted in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, "publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'. # Enable Stackdriver metric dlp.googleapis.com/finding_count. @@ -479,6 +481,8 @@

Method Details

}, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings to Cloud Datahub. }, + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. To learn more about aspects, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are persisted in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, "publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'. # Enable Stackdriver metric dlp.googleapis.com/finding_count. @@ -3277,6 +3281,8 @@

Method Details

}, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings to Cloud Datahub. }, + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. To learn more about aspects, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are persisted in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, "publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'. # Enable Stackdriver metric dlp.googleapis.com/finding_count. @@ -4063,6 +4069,8 @@

Method Details

}, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings to Cloud Datahub. }, + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. To learn more about aspects, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are persisted in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, "publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'. # Enable Stackdriver metric dlp.googleapis.com/finding_count. @@ -7034,6 +7042,8 @@

Method Details

}, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings to Cloud Datahub. }, + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. To learn more about aspects, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are persisted in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, "publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'. # Enable Stackdriver metric dlp.googleapis.com/finding_count. @@ -7820,6 +7830,8 @@

Method Details

}, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings to Cloud Datahub. }, + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. To learn more about aspects, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are persisted in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, "publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'. # Enable Stackdriver metric dlp.googleapis.com/finding_count. @@ -10849,6 +10861,8 @@

Method Details

}, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings to Cloud Datahub. }, + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. To learn more about aspects, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are persisted in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, "publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'. # Enable Stackdriver metric dlp.googleapis.com/finding_count. @@ -11635,6 +11649,8 @@

Method Details

}, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings to Cloud Datahub. }, + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. To learn more about aspects, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are persisted in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, "publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'. # Enable Stackdriver metric dlp.googleapis.com/finding_count. diff --git a/docs/dyn/dlp_v2.projects.locations.jobTriggers.html b/docs/dyn/dlp_v2.projects.locations.jobTriggers.html index e1f62881aa4..9cce529f208 100644 --- a/docs/dyn/dlp_v2.projects.locations.jobTriggers.html +++ b/docs/dyn/dlp_v2.projects.locations.jobTriggers.html @@ -2771,6 +2771,8 @@

Method Details

}, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings to Cloud Datahub. }, + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. To learn more about aspects, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are persisted in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, "publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'. # Enable Stackdriver metric dlp.googleapis.com/finding_count. @@ -3557,6 +3559,8 @@

Method Details

}, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings to Cloud Datahub. }, + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. To learn more about aspects, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are persisted in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, "publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'. # Enable Stackdriver metric dlp.googleapis.com/finding_count. @@ -3887,6 +3891,8 @@

Method Details

}, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings to Cloud Datahub. }, + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. To learn more about aspects, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are persisted in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, "publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'. # Enable Stackdriver metric dlp.googleapis.com/finding_count. @@ -4242,6 +4248,8 @@

Method Details

}, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings to Cloud Datahub. }, + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. To learn more about aspects, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are persisted in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, "publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'. # Enable Stackdriver metric dlp.googleapis.com/finding_count. @@ -4619,6 +4627,8 @@

Method Details

}, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings to Cloud Datahub. }, + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. To learn more about aspects, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are persisted in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, "publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'. # Enable Stackdriver metric dlp.googleapis.com/finding_count. @@ -5078,6 +5088,8 @@

Method Details

}, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings to Cloud Datahub. }, + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. To learn more about aspects, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are persisted in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, "publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'. # Enable Stackdriver metric dlp.googleapis.com/finding_count. @@ -5450,6 +5462,8 @@

Method Details

}, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings to Cloud Datahub. }, + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. To learn more about aspects, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are persisted in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, "publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'. # Enable Stackdriver metric dlp.googleapis.com/finding_count. @@ -5804,6 +5818,8 @@

Method Details

}, "publishFindingsToCloudDataCatalog": { # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag templates are applied to the resource that Cloud DLP scanned. Data Catalog tag templates are stored in the same project and region where the BigQuery table exists. For Cloud DLP to create and apply the tag template, the Cloud DLP service agent must have the `roles/datacatalog.tagTemplateOwner` permission on the project. The tag template contains fields summarizing the results of the DlpJob. Any field values previously written by another DlpJob are deleted. InfoType naming patterns are strictly enforced when using this feature. Findings are persisted in Data Catalog storage and are governed by service-specific policies for Data Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings to Cloud Datahub. }, + "publishFindingsToDataplexCatalog": { # Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. To learn more about aspects, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are persisted in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect # Publish findings as an aspect to Dataplex Universal Catalog. + }, "publishSummaryToCscc": { # Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect # Publish summary to Cloud Security Command Center (Alpha). }, "publishToStackdriver": { # Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'. # Enable Stackdriver metric dlp.googleapis.com/finding_count. diff --git a/googleapiclient/discovery_cache/documents/dlp.v2.json b/googleapiclient/discovery_cache/documents/dlp.v2.json index b79ec21a1a6..c576b20cd17 100644 --- a/googleapiclient/discovery_cache/documents/dlp.v2.json +++ b/googleapiclient/discovery_cache/documents/dlp.v2.json @@ -5123,7 +5123,7 @@ } } }, -"revision": "20250914", +"revision": "20250921", "rootUrl": "https://dlp.googleapis.com/", "schemas": { "GooglePrivacyDlpV2Action": { @@ -5146,6 +5146,10 @@ "$ref": "GooglePrivacyDlpV2PublishFindingsToCloudDataCatalog", "description": "Publish findings to Cloud Datahub." }, +"publishFindingsToDataplexCatalog": { +"$ref": "GooglePrivacyDlpV2PublishFindingsToDataplexCatalog", +"description": "Publish findings as an aspect to Dataplex Universal Catalog." +}, "publishSummaryToCscc": { "$ref": "GooglePrivacyDlpV2PublishSummaryToCscc", "description": "Publish summary to Cloud Security Command Center (Alpha)." @@ -11144,6 +11148,12 @@ "properties": {}, "type": "object" }, +"GooglePrivacyDlpV2PublishFindingsToDataplexCatalog": { +"description": "Publish findings of a DlpJob to Dataplex Universal Catalog as a `sensitive-data-protection-job-result` aspect. To learn more about aspects, see [Send inspection results to Dataplex Universal Catalog as aspects](https://cloud.google.com/sensitive-data-protection/docs/add-aspects-inspection-job). Aspects are persisted in Dataplex Universal Catalog storage and are governed by service-specific policies for Dataplex Universal Catalog. For more information, see [Service Specific Terms](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. This action is allowed only if all resources being scanned are BigQuery tables. Compatible with: Inspect", +"id": "GooglePrivacyDlpV2PublishFindingsToDataplexCatalog", +"properties": {}, +"type": "object" +}, "GooglePrivacyDlpV2PublishSummaryToCscc": { "description": "Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect", "id": "GooglePrivacyDlpV2PublishSummaryToCscc", From 60dab3207e030361020395ae611cb7e8164233dc Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 30 Sep 2025 07:09:36 +0000 Subject: [PATCH 19/42] feat(docs): update the api #### docs:v1 The following keys were deleted: - schemas.PersonProperties.properties.email.readOnly (Total Keys: 1) - schemas.PersonProperties.properties.name.readOnly (Total Keys: 1) --- docs/dyn/docs_v1.documents.html | 96 +++++++++---------- .../discovery_cache/documents/docs.v1.json | 8 +- 2 files changed, 51 insertions(+), 53 deletions(-) diff --git a/docs/dyn/docs_v1.documents.html b/docs/dyn/docs_v1.documents.html index a1f1fa285c2..6451707bb4f 100644 --- a/docs/dyn/docs_v1.documents.html +++ b/docs/dyn/docs_v1.documents.html @@ -1720,8 +1720,8 @@

Method Details

"person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. "personId": "A String", # Output only. The unique ID of this link. "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. - "email": "A String", # Output only. The email address linked to this Person. This field is always present. - "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. + "email": "A String", # The email address linked to this Person. This field is always present. + "name": "A String", # The name of the person if it's displayed in the link text instead of the person's email address. }, "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. "A String", @@ -3723,8 +3723,8 @@

Method Details

"person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. "personId": "A String", # Output only. The unique ID of this link. "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. - "email": "A String", # Output only. The email address linked to this Person. This field is always present. - "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. + "email": "A String", # The email address linked to this Person. This field is always present. + "name": "A String", # The name of the person if it's displayed in the link text instead of the person's email address. }, "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. "A String", @@ -5669,8 +5669,8 @@

Method Details

"person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. "personId": "A String", # Output only. The unique ID of this link. "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. - "email": "A String", # Output only. The email address linked to this Person. This field is always present. - "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. + "email": "A String", # The email address linked to this Person. This field is always present. + "name": "A String", # The name of the person if it's displayed in the link text instead of the person's email address. }, "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. "A String", @@ -7615,8 +7615,8 @@

Method Details

"person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. "personId": "A String", # Output only. The unique ID of this link. "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. - "email": "A String", # Output only. The email address linked to this Person. This field is always present. - "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. + "email": "A String", # The email address linked to this Person. This field is always present. + "name": "A String", # The name of the person if it's displayed in the link text instead of the person's email address. }, "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. "A String", @@ -10737,8 +10737,8 @@

Method Details

"person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. "personId": "A String", # Output only. The unique ID of this link. "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. - "email": "A String", # Output only. The email address linked to this Person. This field is always present. - "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. + "email": "A String", # The email address linked to this Person. This field is always present. + "name": "A String", # The name of the person if it's displayed in the link text instead of the person's email address. }, "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. "A String", @@ -12739,8 +12739,8 @@

Method Details

"person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. "personId": "A String", # Output only. The unique ID of this link. "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. - "email": "A String", # Output only. The email address linked to this Person. This field is always present. - "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. + "email": "A String", # The email address linked to this Person. This field is always present. + "name": "A String", # The name of the person if it's displayed in the link text instead of the person's email address. }, "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. "A String", @@ -14685,8 +14685,8 @@

Method Details

"person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. "personId": "A String", # Output only. The unique ID of this link. "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. - "email": "A String", # Output only. The email address linked to this Person. This field is always present. - "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. + "email": "A String", # The email address linked to this Person. This field is always present. + "name": "A String", # The name of the person if it's displayed in the link text instead of the person's email address. }, "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. "A String", @@ -16631,8 +16631,8 @@

Method Details

"person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. "personId": "A String", # Output only. The unique ID of this link. "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. - "email": "A String", # Output only. The email address linked to this Person. This field is always present. - "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. + "email": "A String", # The email address linked to this Person. This field is always present. + "name": "A String", # The name of the person if it's displayed in the link text instead of the person's email address. }, "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. "A String", @@ -19767,8 +19767,8 @@

Method Details

"person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. "personId": "A String", # Output only. The unique ID of this link. "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. - "email": "A String", # Output only. The email address linked to this Person. This field is always present. - "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. + "email": "A String", # The email address linked to this Person. This field is always present. + "name": "A String", # The name of the person if it's displayed in the link text instead of the person's email address. }, "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. "A String", @@ -21770,8 +21770,8 @@

Method Details

"person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. "personId": "A String", # Output only. The unique ID of this link. "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. - "email": "A String", # Output only. The email address linked to this Person. This field is always present. - "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. + "email": "A String", # The email address linked to this Person. This field is always present. + "name": "A String", # The name of the person if it's displayed in the link text instead of the person's email address. }, "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. "A String", @@ -23716,8 +23716,8 @@

Method Details

"person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. "personId": "A String", # Output only. The unique ID of this link. "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. - "email": "A String", # Output only. The email address linked to this Person. This field is always present. - "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. + "email": "A String", # The email address linked to this Person. This field is always present. + "name": "A String", # The name of the person if it's displayed in the link text instead of the person's email address. }, "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. "A String", @@ -25662,8 +25662,8 @@

Method Details

"person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. "personId": "A String", # Output only. The unique ID of this link. "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. - "email": "A String", # Output only. The email address linked to this Person. This field is always present. - "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. + "email": "A String", # The email address linked to this Person. This field is always present. + "name": "A String", # The name of the person if it's displayed in the link text instead of the person's email address. }, "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. "A String", @@ -28784,8 +28784,8 @@

Method Details

"person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. "personId": "A String", # Output only. The unique ID of this link. "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. - "email": "A String", # Output only. The email address linked to this Person. This field is always present. - "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. + "email": "A String", # The email address linked to this Person. This field is always present. + "name": "A String", # The name of the person if it's displayed in the link text instead of the person's email address. }, "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. "A String", @@ -30786,8 +30786,8 @@

Method Details

"person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. "personId": "A String", # Output only. The unique ID of this link. "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. - "email": "A String", # Output only. The email address linked to this Person. This field is always present. - "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. + "email": "A String", # The email address linked to this Person. This field is always present. + "name": "A String", # The name of the person if it's displayed in the link text instead of the person's email address. }, "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. "A String", @@ -32732,8 +32732,8 @@

Method Details

"person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. "personId": "A String", # Output only. The unique ID of this link. "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. - "email": "A String", # Output only. The email address linked to this Person. This field is always present. - "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. + "email": "A String", # The email address linked to this Person. This field is always present. + "name": "A String", # The name of the person if it's displayed in the link text instead of the person's email address. }, "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. "A String", @@ -34678,8 +34678,8 @@

Method Details

"person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. "personId": "A String", # Output only. The unique ID of this link. "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. - "email": "A String", # Output only. The email address linked to this Person. This field is always present. - "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. + "email": "A String", # The email address linked to this Person. This field is always present. + "name": "A String", # The name of the person if it's displayed in the link text instead of the person's email address. }, "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. "A String", @@ -37828,8 +37828,8 @@

Method Details

"person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. "personId": "A String", # Output only. The unique ID of this link. "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. - "email": "A String", # Output only. The email address linked to this Person. This field is always present. - "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. + "email": "A String", # The email address linked to this Person. This field is always present. + "name": "A String", # The name of the person if it's displayed in the link text instead of the person's email address. }, "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. "A String", @@ -39831,8 +39831,8 @@

Method Details

"person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. "personId": "A String", # Output only. The unique ID of this link. "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. - "email": "A String", # Output only. The email address linked to this Person. This field is always present. - "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. + "email": "A String", # The email address linked to this Person. This field is always present. + "name": "A String", # The name of the person if it's displayed in the link text instead of the person's email address. }, "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. "A String", @@ -41777,8 +41777,8 @@

Method Details

"person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. "personId": "A String", # Output only. The unique ID of this link. "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. - "email": "A String", # Output only. The email address linked to this Person. This field is always present. - "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. + "email": "A String", # The email address linked to this Person. This field is always present. + "name": "A String", # The name of the person if it's displayed in the link text instead of the person's email address. }, "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. "A String", @@ -43723,8 +43723,8 @@

Method Details

"person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. "personId": "A String", # Output only. The unique ID of this link. "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. - "email": "A String", # Output only. The email address linked to this Person. This field is always present. - "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. + "email": "A String", # The email address linked to this Person. This field is always present. + "name": "A String", # The name of the person if it's displayed in the link text instead of the person's email address. }, "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. "A String", @@ -46845,8 +46845,8 @@

Method Details

"person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. "personId": "A String", # Output only. The unique ID of this link. "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. - "email": "A String", # Output only. The email address linked to this Person. This field is always present. - "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. + "email": "A String", # The email address linked to this Person. This field is always present. + "name": "A String", # The name of the person if it's displayed in the link text instead of the person's email address. }, "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. "A String", @@ -48847,8 +48847,8 @@

Method Details

"person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. "personId": "A String", # Output only. The unique ID of this link. "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. - "email": "A String", # Output only. The email address linked to this Person. This field is always present. - "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. + "email": "A String", # The email address linked to this Person. This field is always present. + "name": "A String", # The name of the person if it's displayed in the link text instead of the person's email address. }, "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. "A String", @@ -50793,8 +50793,8 @@

Method Details

"person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. "personId": "A String", # Output only. The unique ID of this link. "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. - "email": "A String", # Output only. The email address linked to this Person. This field is always present. - "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. + "email": "A String", # The email address linked to this Person. This field is always present. + "name": "A String", # The name of the person if it's displayed in the link text instead of the person's email address. }, "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. "A String", @@ -52739,8 +52739,8 @@

Method Details

"person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. "personId": "A String", # Output only. The unique ID of this link. "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. - "email": "A String", # Output only. The email address linked to this Person. This field is always present. - "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. + "email": "A String", # The email address linked to this Person. This field is always present. + "name": "A String", # The name of the person if it's displayed in the link text instead of the person's email address. }, "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. "A String", diff --git a/googleapiclient/discovery_cache/documents/docs.v1.json b/googleapiclient/discovery_cache/documents/docs.v1.json index 37e6cb82b22..98f197e9934 100644 --- a/googleapiclient/discovery_cache/documents/docs.v1.json +++ b/googleapiclient/discovery_cache/documents/docs.v1.json @@ -221,7 +221,7 @@ } } }, -"revision": "20250325", +"revision": "20250917", "rootUrl": "https://docs.googleapis.com/", "schemas": { "AutoText": { @@ -2756,13 +2756,11 @@ "id": "PersonProperties", "properties": { "email": { -"description": "Output only. The email address linked to this Person. This field is always present.", -"readOnly": true, +"description": "The email address linked to this Person. This field is always present.", "type": "string" }, "name": { -"description": "Output only. The name of the person if it's displayed in the link text instead of the person's email address.", -"readOnly": true, +"description": "The name of the person if it's displayed in the link text instead of the person's email address.", "type": "string" } }, From 9ef10c06c4dafae8332c3a934d470eb1d356a304 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 30 Sep 2025 07:09:36 +0000 Subject: [PATCH 20/42] feat(documentai): update the api #### documentai:v1 The following keys were deleted: - schemas.GoogleCloudDocumentaiV1Processor.properties.activeSchemaVersion.type (Total Keys: 1) #### documentai:v1beta3 The following keys were deleted: - schemas.GoogleCloudDocumentaiV1beta3Processor.properties.activeSchemaVersion.type (Total Keys: 1) --- docs/dyn/documentai_v1.projects.locations.processors.html | 4 ---- .../documentai_v1beta3.projects.locations.processors.html | 4 ---- .../discovery_cache/documents/documentai.v1.json | 6 +----- .../discovery_cache/documents/documentai.v1beta3.json | 6 +----- 4 files changed, 2 insertions(+), 18 deletions(-) diff --git a/docs/dyn/documentai_v1.projects.locations.processors.html b/docs/dyn/documentai_v1.projects.locations.processors.html index d9cd53f11f2..9a1ffd8a704 100644 --- a/docs/dyn/documentai_v1.projects.locations.processors.html +++ b/docs/dyn/documentai_v1.projects.locations.processors.html @@ -271,7 +271,6 @@

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. @@ -299,7 +298,6 @@

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. @@ -451,7 +449,6 @@

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. @@ -491,7 +488,6 @@

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. diff --git a/docs/dyn/documentai_v1beta3.projects.locations.processors.html b/docs/dyn/documentai_v1beta3.projects.locations.processors.html index d37c1d8e616..6ef9e77968a 100644 --- a/docs/dyn/documentai_v1beta3.projects.locations.processors.html +++ b/docs/dyn/documentai_v1beta3.projects.locations.processors.html @@ -308,7 +308,6 @@

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. @@ -336,7 +335,6 @@

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,7 +486,6 @@

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. @@ -528,7 +525,6 @@

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. diff --git a/googleapiclient/discovery_cache/documents/documentai.v1.json b/googleapiclient/discovery_cache/documents/documentai.v1.json index 7a7ab9b5e1e..f951464bbff 100644 --- a/googleapiclient/discovery_cache/documents/documentai.v1.json +++ b/googleapiclient/discovery_cache/documents/documentai.v1.json @@ -1048,7 +1048,7 @@ } } }, -"revision": "20250914", +"revision": "20250922", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "CloudAiDocumentaiLabHifiaToolsValidationValidatorInput": { @@ -4754,10 +4754,6 @@ 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", diff --git a/googleapiclient/discovery_cache/documents/documentai.v1beta3.json b/googleapiclient/discovery_cache/documents/documentai.v1beta3.json index df8ca606c19..f533687b898 100644 --- a/googleapiclient/discovery_cache/documents/documentai.v1beta3.json +++ b/googleapiclient/discovery_cache/documents/documentai.v1beta3.json @@ -1290,7 +1290,7 @@ } } }, -"revision": "20250914", +"revision": "20250922", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "CloudAiDocumentaiLabHifiaToolsValidationValidatorInput": { @@ -6184,10 +6184,6 @@ 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", From 0499205d24a30b49ecd7daefc84f8f1b98d43ee3 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 30 Sep 2025 07:09:36 +0000 Subject: [PATCH 21/42] feat(firebaseappdistribution): update the api #### firebaseappdistribution:v1 The following keys were added: - resources.projects.resources.apps.resources.releases.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - schemas.GoogleLongrunningListOperationsResponse.properties.unreachable (Total Keys: 2) #### firebaseappdistribution:v1alpha The following keys were added: - schemas.GoogleFirebaseAppdistroV1alphaGoalAction.properties.cachingType (Total Keys: 2) --- ..._v1.projects.apps.releases.operations.html | 8 ++++++-- ..._v1alpha.projects.apps.releases.tests.html | 4 ++++ .../documents/firebaseappdistribution.v1.json | 14 +++++++++++++- .../firebaseappdistribution.v1alpha.json | 19 ++++++++++++++++++- 4 files changed, 41 insertions(+), 4 deletions(-) diff --git a/docs/dyn/firebaseappdistribution_v1.projects.apps.releases.operations.html b/docs/dyn/firebaseappdistribution_v1.projects.apps.releases.operations.html index 9eca8120e0c..d67fc5e1bf9 100644 --- a/docs/dyn/firebaseappdistribution_v1.projects.apps.releases.operations.html +++ b/docs/dyn/firebaseappdistribution_v1.projects.apps.releases.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()

@@ -179,7 +179,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:
@@ -187,6 +187,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
@@ -218,6 +219,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/firebaseappdistribution_v1alpha.projects.apps.releases.tests.html b/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.releases.tests.html index 853c61953cb..0e2862bedae 100644 --- a/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.releases.tests.html +++ b/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.releases.tests.html @@ -154,6 +154,7 @@

Method Details

"goalDetails": { # Details for a goal step. # Output only. Details for a goal step. "goalActions": [ # Output only. The actions taken by the AI while attempting to accomplish the goal. { # An action taken by the AI agent while attempting to accomplish a goal. + "cachingType": "A String", # Output only. The type of caching used to determine the action. "debugInfo": { # Information to help the customer understand why the agent took this action. # Output only. Debug information explaining why the agent to the specific action. "annotatedScreenshotUri": "A String", # Output only. URI of the screenshot with elements labeled which was used by the agent. "jsonUri": "A String", # Output only. Structured data explaining the agent's choice. @@ -318,6 +319,7 @@

Method Details

"goalDetails": { # Details for a goal step. # Output only. Details for a goal step. "goalActions": [ # Output only. The actions taken by the AI while attempting to accomplish the goal. { # An action taken by the AI agent while attempting to accomplish a goal. + "cachingType": "A String", # Output only. The type of caching used to determine the action. "debugInfo": { # Information to help the customer understand why the agent took this action. # Output only. Debug information explaining why the agent to the specific action. "annotatedScreenshotUri": "A String", # Output only. URI of the screenshot with elements labeled which was used by the agent. "jsonUri": "A String", # Output only. Structured data explaining the agent's choice. @@ -488,6 +490,7 @@

Method Details

"goalDetails": { # Details for a goal step. # Output only. Details for a goal step. "goalActions": [ # Output only. The actions taken by the AI while attempting to accomplish the goal. { # An action taken by the AI agent while attempting to accomplish a goal. + "cachingType": "A String", # Output only. The type of caching used to determine the action. "debugInfo": { # Information to help the customer understand why the agent took this action. # Output only. Debug information explaining why the agent to the specific action. "annotatedScreenshotUri": "A String", # Output only. URI of the screenshot with elements labeled which was used by the agent. "jsonUri": "A String", # Output only. Structured data explaining the agent's choice. @@ -668,6 +671,7 @@

Method Details

"goalDetails": { # Details for a goal step. # Output only. Details for a goal step. "goalActions": [ # Output only. The actions taken by the AI while attempting to accomplish the goal. { # An action taken by the AI agent while attempting to accomplish a goal. + "cachingType": "A String", # Output only. The type of caching used to determine the action. "debugInfo": { # Information to help the customer understand why the agent took this action. # Output only. Debug information explaining why the agent to the specific action. "annotatedScreenshotUri": "A String", # Output only. URI of the screenshot with elements labeled which was used by the agent. "jsonUri": "A String", # Output only. Structured data explaining the agent's choice. diff --git a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1.json b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1.json index 3274570e5a9..7cbb2193dc1 100644 --- a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1.json +++ b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1.json @@ -546,6 +546,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", @@ -941,7 +946,7 @@ } } }, -"revision": "20250822", +"revision": "20250924", "rootUrl": "https://firebaseappdistribution.googleapis.com/", "schemas": { "GdataBlobstore2Info": { @@ -1862,6 +1867,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" diff --git a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json index 55495903bfb..4aeb0b475fd 100644 --- a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json @@ -812,7 +812,7 @@ } } }, -"revision": "20250916", +"revision": "20250925", "rootUrl": "https://firebaseappdistribution.googleapis.com/", "schemas": { "AndroidxCrawlerOutputPoint": { @@ -1615,6 +1615,23 @@ "description": "An action taken by the AI agent while attempting to accomplish a goal.", "id": "GoogleFirebaseAppdistroV1alphaGoalAction", "properties": { +"cachingType": { +"description": "Output only. The type of caching used to determine the action.", +"enum": [ +"CACHING_TYPE_UNSPECIFIED", +"NO_CACHING", +"CACHE_AND_MODEL", +"CACHE_ONLY" +], +"enumDescriptions": [ +"Caching type unspecified.", +"The model alone was used to determine the action with no caching.", +"The model used information from a previous successful run to determine the action.", +"The action was replayed from a previous successful run without model input." +], +"readOnly": true, +"type": "string" +}, "debugInfo": { "$ref": "GoogleFirebaseAppdistroV1alphaGoalActionDebugInfo", "description": "Output only. Debug information explaining why the agent to the specific action.", From 873fe995f8b36eb247161528d5c9d873a4cf4a76 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 30 Sep 2025 07:09:36 +0000 Subject: [PATCH 22/42] feat(firebaseapphosting): update the api #### firebaseapphosting:v1beta The following keys were added: - schemas.Backend.properties.overrideEnv (Total Keys: 2) --- ...ng_v1beta.projects.locations.backends.html | 40 +++++++++++++++++++ .../documents/firebaseapphosting.v1beta.json | 9 ++++- 2 files changed, 48 insertions(+), 1 deletion(-) diff --git a/docs/dyn/firebaseapphosting_v1beta.projects.locations.backends.html b/docs/dyn/firebaseapphosting_v1beta.projects.locations.backends.html index d1cff0a46a7..49a82435d79 100644 --- a/docs/dyn/firebaseapphosting_v1beta.projects.locations.backends.html +++ b/docs/dyn/firebaseapphosting_v1beta.projects.locations.backends.html @@ -156,6 +156,16 @@

Method Details

], "mode": "A String", # Optional. Deprecated: Use `environment` instead. "name": "A String", # Identifier. The resource name of the backend. Format: `projects/{project}/locations/{locationId}/backends/{backendId}`. + "overrideEnv": [ # Optional. Override environment variables for this Backend. + { # Environment variables for this build. + "availability": [ # Optional. Where this variable should be made available. If left unspecified, will be available in both BUILD and BACKEND. + "A String", + ], + "secret": "A String", # A fully qualified secret version. The value of the secret will be accessed once while building the application and once per cold start of the container at runtime. The service account used by Cloud Build and by Cloud Run must each have the `secretmanager.versions.access` permission on the secret. + "value": "A String", # A plaintext value. This value is encrypted at rest, but all project readers can view the value when reading your backend configuration. + "variable": "A String", # Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run + }, + ], "reconciling": True or False, # Output only. A field that, if true, indicates that the system is working to make adjustments to the backend during a LRO. "requestLogsDisabled": True or False, # Optional. A field that, if true, indicates that incoming request logs are disabled for this backend. Incoming request logs are enabled by default. "serviceAccount": "A String", # Required. The name of the service account used for Cloud Build and Cloud Run. Should have the role roles/firebaseapphosting.computeRunner or equivalent permissions. @@ -276,6 +286,16 @@

Method Details

], "mode": "A String", # Optional. Deprecated: Use `environment` instead. "name": "A String", # Identifier. The resource name of the backend. Format: `projects/{project}/locations/{locationId}/backends/{backendId}`. + "overrideEnv": [ # Optional. Override environment variables for this Backend. + { # Environment variables for this build. + "availability": [ # Optional. Where this variable should be made available. If left unspecified, will be available in both BUILD and BACKEND. + "A String", + ], + "secret": "A String", # A fully qualified secret version. The value of the secret will be accessed once while building the application and once per cold start of the container at runtime. The service account used by Cloud Build and by Cloud Run must each have the `secretmanager.versions.access` permission on the secret. + "value": "A String", # A plaintext value. This value is encrypted at rest, but all project readers can view the value when reading your backend configuration. + "variable": "A String", # Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run + }, + ], "reconciling": True or False, # Output only. A field that, if true, indicates that the system is working to make adjustments to the backend during a LRO. "requestLogsDisabled": True or False, # Optional. A field that, if true, indicates that incoming request logs are disabled for this backend. Incoming request logs are enabled by default. "serviceAccount": "A String", # Required. The name of the service account used for Cloud Build and Cloud Run. Should have the role roles/firebaseapphosting.computeRunner or equivalent permissions. @@ -333,6 +353,16 @@

Method Details

], "mode": "A String", # Optional. Deprecated: Use `environment` instead. "name": "A String", # Identifier. The resource name of the backend. Format: `projects/{project}/locations/{locationId}/backends/{backendId}`. + "overrideEnv": [ # Optional. Override environment variables for this Backend. + { # Environment variables for this build. + "availability": [ # Optional. Where this variable should be made available. If left unspecified, will be available in both BUILD and BACKEND. + "A String", + ], + "secret": "A String", # A fully qualified secret version. The value of the secret will be accessed once while building the application and once per cold start of the container at runtime. The service account used by Cloud Build and by Cloud Run must each have the `secretmanager.versions.access` permission on the secret. + "value": "A String", # A plaintext value. This value is encrypted at rest, but all project readers can view the value when reading your backend configuration. + "variable": "A String", # Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run + }, + ], "reconciling": True or False, # Output only. A field that, if true, indicates that the system is working to make adjustments to the backend during a LRO. "requestLogsDisabled": True or False, # Optional. A field that, if true, indicates that incoming request logs are disabled for this backend. Incoming request logs are enabled by default. "serviceAccount": "A String", # Required. The name of the service account used for Cloud Build and Cloud Run. Should have the role roles/firebaseapphosting.computeRunner or equivalent permissions. @@ -398,6 +428,16 @@

Method Details

], "mode": "A String", # Optional. Deprecated: Use `environment` instead. "name": "A String", # Identifier. The resource name of the backend. Format: `projects/{project}/locations/{locationId}/backends/{backendId}`. + "overrideEnv": [ # Optional. Override environment variables for this Backend. + { # Environment variables for this build. + "availability": [ # Optional. Where this variable should be made available. If left unspecified, will be available in both BUILD and BACKEND. + "A String", + ], + "secret": "A String", # A fully qualified secret version. The value of the secret will be accessed once while building the application and once per cold start of the container at runtime. The service account used by Cloud Build and by Cloud Run must each have the `secretmanager.versions.access` permission on the secret. + "value": "A String", # A plaintext value. This value is encrypted at rest, but all project readers can view the value when reading your backend configuration. + "variable": "A String", # Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run + }, + ], "reconciling": True or False, # Output only. A field that, if true, indicates that the system is working to make adjustments to the backend during a LRO. "requestLogsDisabled": True or False, # Optional. A field that, if true, indicates that incoming request logs are disabled for this backend. Incoming request logs are enabled by default. "serviceAccount": "A String", # Required. The name of the service account used for Cloud Build and Cloud Run. Should have the role roles/firebaseapphosting.computeRunner or equivalent permissions. diff --git a/googleapiclient/discovery_cache/documents/firebaseapphosting.v1beta.json b/googleapiclient/discovery_cache/documents/firebaseapphosting.v1beta.json index 93160efb37c..a442315485e 100644 --- a/googleapiclient/discovery_cache/documents/firebaseapphosting.v1beta.json +++ b/googleapiclient/discovery_cache/documents/firebaseapphosting.v1beta.json @@ -1098,7 +1098,7 @@ } } }, -"revision": "20250904", +"revision": "20250918", "rootUrl": "https://firebaseapphosting.googleapis.com/", "schemas": { "ArchiveSource": { @@ -1196,6 +1196,13 @@ "description": "Identifier. The resource name of the backend. Format: `projects/{project}/locations/{locationId}/backends/{backendId}`.", "type": "string" }, +"overrideEnv": { +"description": "Optional. Override environment variables for this Backend.", +"items": { +"$ref": "EnvironmentVariable" +}, +"type": "array" +}, "reconciling": { "description": "Output only. A field that, if true, indicates that the system is working to make adjustments to the backend during a LRO.", "readOnly": true, From 54e550995df5b4d47367303e7a5a39625275ad24 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 30 Sep 2025 07:09:36 +0000 Subject: [PATCH 23/42] feat(firestore): update the api #### firestore:v1 The following keys were added: - schemas.GoogleFirestoreAdminV1Database.properties.firestoreDataAccessMode.type (Total Keys: 1) - schemas.GoogleFirestoreAdminV1Database.properties.mongodbCompatibleDataAccessMode.type (Total Keys: 1) - schemas.GoogleFirestoreAdminV1Database.properties.realtimeUpdatesMode.type (Total Keys: 1) The following keys were changed: - endpoints (Total Keys: 1) #### firestore:v1beta1 The following keys were changed: - endpoints (Total Keys: 1) #### firestore:v1beta2 The following keys were changed: - endpoints (Total Keys: 1) --- docs/dyn/firestore_v1.projects.databases.html | 12 + .../documents/firestore.v1.json | 474 +++++++++++++++++- .../documents/firestore.v1beta1.json | 432 +++++++++++++++- .../documents/firestore.v1beta2.json | 432 +++++++++++++++- 4 files changed, 1347 insertions(+), 3 deletions(-) diff --git a/docs/dyn/firestore_v1.projects.databases.html b/docs/dyn/firestore_v1.projects.databases.html index 25ed0422728..f20c69a5dac 100644 --- a/docs/dyn/firestore_v1.projects.databases.html +++ b/docs/dyn/firestore_v1.projects.databases.html @@ -268,12 +268,15 @@

Method Details

"deleteTime": "A String", # Output only. The timestamp at which this database was deleted. Only set if the database has been deleted. "earliestVersionTime": "A String", # Output only. The earliest timestamp at which older versions of the data can be read from the database. See [version_retention_period] above; this field is populated with `now - version_retention_period`. This value is continuously updated, and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery. "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. + "firestoreDataAccessMode": "A String", # Optional. The Firestore API data access mode to use for this database. If not set on write: - the default value is DATA_ACCESS_MODE_DISABLED for Enterprise Edition. - the default value is DATA_ACCESS_MODE_ENABLED for Standard Edition. "freeTier": True or False, # Output only. Background: Free tier is the ability of a Firestore database to use a small amount of resources every day without being charged. Once usage exceeds the free tier limit further usage is charged. Whether this database can make use of the free tier. Only one database per project can be eligible for the free tier. The first (or next) database that is created in a project without a free tier database will be marked as eligible for the free tier. Databases that are created while there is a free tier database will not be eligible for the free tier. "keyPrefix": "A String", # Output only. The key_prefix for this database. This key_prefix is used, in combination with the project ID ("~") to construct the application ID that is returned from the Cloud Datastore APIs in Google App Engine first generation runtimes. This value may be empty in which case the appid to use for URL-encoded keys is the project_id (eg: foo instead of v~foo). "locationId": "A String", # The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations. + "mongodbCompatibleDataAccessMode": "A String", # Optional. The MongoDB compatible API data access mode to use for this database. If not set on write, the default value is DATA_ACCESS_MODE_ENABLED for Enterprise Edition. The value is always DATA_ACCESS_MODE_DISABLED for Standard Edition. "name": "A String", # The resource name of the Database. Format: `projects/{project}/databases/{database}` "pointInTimeRecoveryEnablement": "A String", # Whether to enable the PITR feature on this database. "previousId": "A String", # Output only. The database resource's prior database ID. This field is only populated for deleted databases. + "realtimeUpdatesMode": "A String", # Immutable. The default Realtime Updates mode to use for this database. "sourceInfo": { # Information about the provenance of this database. # Output only. Information about the provenance of this database. "backup": { # Information about a backup that was used to restore a database. # If set, this database was restored from the specified backup (or a snapshot thereof). "backup": "A String", # The resource name of the backup that was used to restore this database. Format: `projects/{project}/locations/{location}/backups/{backup}`. @@ -433,12 +436,15 @@

Method Details

"deleteTime": "A String", # Output only. The timestamp at which this database was deleted. Only set if the database has been deleted. "earliestVersionTime": "A String", # Output only. The earliest timestamp at which older versions of the data can be read from the database. See [version_retention_period] above; this field is populated with `now - version_retention_period`. This value is continuously updated, and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery. "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. + "firestoreDataAccessMode": "A String", # Optional. The Firestore API data access mode to use for this database. If not set on write: - the default value is DATA_ACCESS_MODE_DISABLED for Enterprise Edition. - the default value is DATA_ACCESS_MODE_ENABLED for Standard Edition. "freeTier": True or False, # Output only. Background: Free tier is the ability of a Firestore database to use a small amount of resources every day without being charged. Once usage exceeds the free tier limit further usage is charged. Whether this database can make use of the free tier. Only one database per project can be eligible for the free tier. The first (or next) database that is created in a project without a free tier database will be marked as eligible for the free tier. Databases that are created while there is a free tier database will not be eligible for the free tier. "keyPrefix": "A String", # Output only. The key_prefix for this database. This key_prefix is used, in combination with the project ID ("~") to construct the application ID that is returned from the Cloud Datastore APIs in Google App Engine first generation runtimes. This value may be empty in which case the appid to use for URL-encoded keys is the project_id (eg: foo instead of v~foo). "locationId": "A String", # The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations. + "mongodbCompatibleDataAccessMode": "A String", # Optional. The MongoDB compatible API data access mode to use for this database. If not set on write, the default value is DATA_ACCESS_MODE_ENABLED for Enterprise Edition. The value is always DATA_ACCESS_MODE_DISABLED for Standard Edition. "name": "A String", # The resource name of the Database. Format: `projects/{project}/databases/{database}` "pointInTimeRecoveryEnablement": "A String", # Whether to enable the PITR feature on this database. "previousId": "A String", # Output only. The database resource's prior database ID. This field is only populated for deleted databases. + "realtimeUpdatesMode": "A String", # Immutable. The default Realtime Updates mode to use for this database. "sourceInfo": { # Information about the provenance of this database. # Output only. Information about the provenance of this database. "backup": { # Information about a backup that was used to restore a database. # If set, this database was restored from the specified backup (or a snapshot thereof). "backup": "A String", # The resource name of the backup that was used to restore this database. Format: `projects/{project}/locations/{location}/backups/{backup}`. @@ -535,12 +541,15 @@

Method Details

"deleteTime": "A String", # Output only. The timestamp at which this database was deleted. Only set if the database has been deleted. "earliestVersionTime": "A String", # Output only. The earliest timestamp at which older versions of the data can be read from the database. See [version_retention_period] above; this field is populated with `now - version_retention_period`. This value is continuously updated, and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery. "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. + "firestoreDataAccessMode": "A String", # Optional. The Firestore API data access mode to use for this database. If not set on write: - the default value is DATA_ACCESS_MODE_DISABLED for Enterprise Edition. - the default value is DATA_ACCESS_MODE_ENABLED for Standard Edition. "freeTier": True or False, # Output only. Background: Free tier is the ability of a Firestore database to use a small amount of resources every day without being charged. Once usage exceeds the free tier limit further usage is charged. Whether this database can make use of the free tier. Only one database per project can be eligible for the free tier. The first (or next) database that is created in a project without a free tier database will be marked as eligible for the free tier. Databases that are created while there is a free tier database will not be eligible for the free tier. "keyPrefix": "A String", # Output only. The key_prefix for this database. This key_prefix is used, in combination with the project ID ("~") to construct the application ID that is returned from the Cloud Datastore APIs in Google App Engine first generation runtimes. This value may be empty in which case the appid to use for URL-encoded keys is the project_id (eg: foo instead of v~foo). "locationId": "A String", # The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations. + "mongodbCompatibleDataAccessMode": "A String", # Optional. The MongoDB compatible API data access mode to use for this database. If not set on write, the default value is DATA_ACCESS_MODE_ENABLED for Enterprise Edition. The value is always DATA_ACCESS_MODE_DISABLED for Standard Edition. "name": "A String", # The resource name of the Database. Format: `projects/{project}/databases/{database}` "pointInTimeRecoveryEnablement": "A String", # Whether to enable the PITR feature on this database. "previousId": "A String", # Output only. The database resource's prior database ID. This field is only populated for deleted databases. + "realtimeUpdatesMode": "A String", # Immutable. The default Realtime Updates mode to use for this database. "sourceInfo": { # Information about the provenance of this database. # Output only. Information about the provenance of this database. "backup": { # Information about a backup that was used to restore a database. # If set, this database was restored from the specified backup (or a snapshot thereof). "backup": "A String", # The resource name of the backup that was used to restore this database. Format: `projects/{project}/locations/{location}/backups/{backup}`. @@ -586,12 +595,15 @@

Method Details

"deleteTime": "A String", # Output only. The timestamp at which this database was deleted. Only set if the database has been deleted. "earliestVersionTime": "A String", # Output only. The earliest timestamp at which older versions of the data can be read from the database. See [version_retention_period] above; this field is populated with `now - version_retention_period`. This value is continuously updated, and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery. "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. + "firestoreDataAccessMode": "A String", # Optional. The Firestore API data access mode to use for this database. If not set on write: - the default value is DATA_ACCESS_MODE_DISABLED for Enterprise Edition. - the default value is DATA_ACCESS_MODE_ENABLED for Standard Edition. "freeTier": True or False, # Output only. Background: Free tier is the ability of a Firestore database to use a small amount of resources every day without being charged. Once usage exceeds the free tier limit further usage is charged. Whether this database can make use of the free tier. Only one database per project can be eligible for the free tier. The first (or next) database that is created in a project without a free tier database will be marked as eligible for the free tier. Databases that are created while there is a free tier database will not be eligible for the free tier. "keyPrefix": "A String", # Output only. The key_prefix for this database. This key_prefix is used, in combination with the project ID ("~") to construct the application ID that is returned from the Cloud Datastore APIs in Google App Engine first generation runtimes. This value may be empty in which case the appid to use for URL-encoded keys is the project_id (eg: foo instead of v~foo). "locationId": "A String", # The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations. + "mongodbCompatibleDataAccessMode": "A String", # Optional. The MongoDB compatible API data access mode to use for this database. If not set on write, the default value is DATA_ACCESS_MODE_ENABLED for Enterprise Edition. The value is always DATA_ACCESS_MODE_DISABLED for Standard Edition. "name": "A String", # The resource name of the Database. Format: `projects/{project}/databases/{database}` "pointInTimeRecoveryEnablement": "A String", # Whether to enable the PITR feature on this database. "previousId": "A String", # Output only. The database resource's prior database ID. This field is only populated for deleted databases. + "realtimeUpdatesMode": "A String", # Immutable. The default Realtime Updates mode to use for this database. "sourceInfo": { # Information about the provenance of this database. # Output only. Information about the provenance of this database. "backup": { # Information about a backup that was used to restore a database. # If set, this database was restored from the specified backup (or a snapshot thereof). "backup": "A String", # The resource name of the backup that was used to restore this database. Format: `projects/{project}/locations/{location}/backups/{backup}`. diff --git a/googleapiclient/discovery_cache/documents/firestore.v1.json b/googleapiclient/discovery_cache/documents/firestore.v1.json index ae7f36aca5b..bb88f4dae9c 100644 --- a/googleapiclient/discovery_cache/documents/firestore.v1.json +++ b/googleapiclient/discovery_cache/documents/firestore.v1.json @@ -21,13 +21,443 @@ "endpoints": [ { "description": "Regional Endpoint", +"endpointUrl": "https://firestore.africa-south1.rep.googleapis.com/", +"location": "africa-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.asia-east1.rep.googleapis.com/", +"location": "asia-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.asia-east2.rep.googleapis.com/", +"location": "asia-east2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.asia-northeast1.rep.googleapis.com/", +"location": "asia-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.asia-northeast2.rep.googleapis.com/", +"location": "asia-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.asia-northeast3.rep.googleapis.com/", +"location": "asia-northeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.asia-south1.rep.googleapis.com/", +"location": "asia-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.asia-south2.rep.googleapis.com/", +"location": "asia-south2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.asia-southeast1.rep.googleapis.com/", +"location": "asia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.asia-southeast2.rep.googleapis.com/", +"location": "asia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.australia-southeast1.rep.googleapis.com/", +"location": "australia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.australia-southeast2.rep.googleapis.com/", +"location": "australia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.europe-central2.rep.googleapis.com/", +"location": "europe-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.europe-north1.rep.googleapis.com/", +"location": "europe-north1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.europe-north2.rep.googleapis.com/", +"location": "europe-north2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.europe-southwest1.rep.googleapis.com/", +"location": "europe-southwest1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.europe-west1.rep.googleapis.com/", +"location": "europe-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.europe-west10.rep.googleapis.com/", +"location": "europe-west10" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.europe-west12.rep.googleapis.com/", +"location": "europe-west12" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.europe-west2.rep.googleapis.com/", +"location": "europe-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.europe-west3.rep.googleapis.com/", +"location": "europe-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.europe-west4.rep.googleapis.com/", +"location": "europe-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.europe-west6.rep.googleapis.com/", +"location": "europe-west6" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.europe-west8.rep.googleapis.com/", +"location": "europe-west8" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.europe-west9.rep.googleapis.com/", +"location": "europe-west9" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.me-central1.rep.googleapis.com/", +"location": "me-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.me-central2.rep.googleapis.com/", +"location": "me-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.me-west1.rep.googleapis.com/", +"location": "me-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.northamerica-northeast1.rep.googleapis.com/", +"location": "northamerica-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.northamerica-northeast2.rep.googleapis.com/", +"location": "northamerica-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.northamerica-south1.rep.googleapis.com/", +"location": "northamerica-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.southamerica-east1.rep.googleapis.com/", +"location": "southamerica-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.southamerica-west1.rep.googleapis.com/", +"location": "southamerica-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.us-central1.rep.googleapis.com/", +"location": "us-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.us-east1.rep.googleapis.com/", +"location": "us-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.us-east4.rep.googleapis.com/", +"location": "us-east4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.us-east5.rep.googleapis.com/", +"location": "us-east5" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://firestore.us-east7.rep.googleapis.com/", "location": "us-east7" }, { "description": "Regional Endpoint", +"endpointUrl": "https://firestore.us-south1.rep.googleapis.com/", +"location": "us-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.us-west1.rep.googleapis.com/", +"location": "us-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.us-west2.rep.googleapis.com/", +"location": "us-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.us-west3.rep.googleapis.com/", +"location": "us-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.us-west4.rep.googleapis.com/", +"location": "us-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.us-west8.rep.googleapis.com/", +"location": "us-west8" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.africa-south1.rep.googleapis.com/", +"location": "africa-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.asia-east1.rep.googleapis.com/", +"location": "asia-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.asia-east2.rep.googleapis.com/", +"location": "asia-east2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.asia-northeast1.rep.googleapis.com/", +"location": "asia-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.asia-northeast2.rep.googleapis.com/", +"location": "asia-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.asia-northeast3.rep.googleapis.com/", +"location": "asia-northeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.asia-south1.rep.googleapis.com/", +"location": "asia-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.asia-south2.rep.googleapis.com/", +"location": "asia-south2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.asia-southeast1.rep.googleapis.com/", +"location": "asia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.asia-southeast2.rep.googleapis.com/", +"location": "asia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.australia-southeast1.rep.googleapis.com/", +"location": "australia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.australia-southeast2.rep.googleapis.com/", +"location": "australia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.europe-central2.rep.googleapis.com/", +"location": "europe-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.europe-north1.rep.googleapis.com/", +"location": "europe-north1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.europe-north2.rep.googleapis.com/", +"location": "europe-north2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.europe-southwest1.rep.googleapis.com/", +"location": "europe-southwest1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.europe-west1.rep.googleapis.com/", +"location": "europe-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.europe-west10.rep.googleapis.com/", +"location": "europe-west10" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.europe-west12.rep.googleapis.com/", +"location": "europe-west12" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.europe-west2.rep.googleapis.com/", +"location": "europe-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.europe-west3.rep.googleapis.com/", +"location": "europe-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.europe-west4.rep.googleapis.com/", +"location": "europe-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.europe-west6.rep.googleapis.com/", +"location": "europe-west6" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.europe-west8.rep.googleapis.com/", +"location": "europe-west8" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.europe-west9.rep.googleapis.com/", +"location": "europe-west9" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.me-central1.rep.googleapis.com/", +"location": "me-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.me-central2.rep.googleapis.com/", +"location": "me-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.me-west1.rep.googleapis.com/", +"location": "me-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.northamerica-northeast1.rep.googleapis.com/", +"location": "northamerica-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.northamerica-northeast2.rep.googleapis.com/", +"location": "northamerica-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.northamerica-south1.rep.googleapis.com/", +"location": "northamerica-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.southamerica-east1.rep.googleapis.com/", +"location": "southamerica-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.southamerica-west1.rep.googleapis.com/", +"location": "southamerica-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.us-central1.rep.googleapis.com/", +"location": "us-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.us-east1.rep.googleapis.com/", +"location": "us-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.us-east4.rep.googleapis.com/", +"location": "us-east4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.us-east5.rep.googleapis.com/", +"location": "us-east5" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://batch-firestore.us-east7.rep.googleapis.com/", "location": "us-east7" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.us-south1.rep.googleapis.com/", +"location": "us-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.us-west1.rep.googleapis.com/", +"location": "us-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.us-west2.rep.googleapis.com/", +"location": "us-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.us-west3.rep.googleapis.com/", +"location": "us-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.us-west4.rep.googleapis.com/", +"location": "us-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.us-west8.rep.googleapis.com/", +"location": "us-west8" } ], "fullyEncodeReservedExpansion": true, @@ -1961,7 +2391,7 @@ } } }, -"revision": "20250908", +"revision": "20250918", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { @@ -3089,6 +3519,20 @@ "description": "This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.", "type": "string" }, +"firestoreDataAccessMode": { +"description": "Optional. The Firestore API data access mode to use for this database. If not set on write: - the default value is DATA_ACCESS_MODE_DISABLED for Enterprise Edition. - the default value is DATA_ACCESS_MODE_ENABLED for Standard Edition.", +"enum": [ +"DATA_ACCESS_MODE_UNSPECIFIED", +"DATA_ACCESS_MODE_ENABLED", +"DATA_ACCESS_MODE_DISABLED" +], +"enumDescriptions": [ +"Not Used.", +"Accessing the database through the API is allowed.", +"Accessing the database through the API is disallowed." +], +"type": "string" +}, "freeTier": { "description": "Output only. Background: Free tier is the ability of a Firestore database to use a small amount of resources every day without being charged. Once usage exceeds the free tier limit further usage is charged. Whether this database can make use of the free tier. Only one database per project can be eligible for the free tier. The first (or next) database that is created in a project without a free tier database will be marked as eligible for the free tier. Databases that are created while there is a free tier database will not be eligible for the free tier.", "readOnly": true, @@ -3103,6 +3547,20 @@ "description": "The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations.", "type": "string" }, +"mongodbCompatibleDataAccessMode": { +"description": "Optional. The MongoDB compatible API data access mode to use for this database. If not set on write, the default value is DATA_ACCESS_MODE_ENABLED for Enterprise Edition. The value is always DATA_ACCESS_MODE_DISABLED for Standard Edition.", +"enum": [ +"DATA_ACCESS_MODE_UNSPECIFIED", +"DATA_ACCESS_MODE_ENABLED", +"DATA_ACCESS_MODE_DISABLED" +], +"enumDescriptions": [ +"Not Used.", +"Accessing the database through the API is allowed.", +"Accessing the database through the API is disallowed." +], +"type": "string" +}, "name": { "description": "The resource name of the Database. Format: `projects/{project}/databases/{database}`", "type": "string" @@ -3126,6 +3584,20 @@ "readOnly": true, "type": "string" }, +"realtimeUpdatesMode": { +"description": "Immutable. The default Realtime Updates mode to use for this database.", +"enum": [ +"REALTIME_UPDATES_MODE_UNSPECIFIED", +"REALTIME_UPDATES_ENABLED", +"REALTIME_UPDATES_DISABLED" +], +"enumDescriptions": [ +"The Realtime Updates feature is not specified.", +"The Realtime Updates feature is enabled by default. This could potentially degrade write performance for the database.", +"The Realtime Updates feature is disabled by default." +], +"type": "string" +}, "sourceInfo": { "$ref": "GoogleFirestoreAdminV1SourceInfo", "description": "Output only. Information about the provenance of this database.", diff --git a/googleapiclient/discovery_cache/documents/firestore.v1beta1.json b/googleapiclient/discovery_cache/documents/firestore.v1beta1.json index 174c775b828..1af3aaceaa9 100644 --- a/googleapiclient/discovery_cache/documents/firestore.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/firestore.v1beta1.json @@ -21,13 +21,443 @@ "endpoints": [ { "description": "Regional Endpoint", +"endpointUrl": "https://firestore.africa-south1.rep.googleapis.com/", +"location": "africa-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.asia-east1.rep.googleapis.com/", +"location": "asia-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.asia-east2.rep.googleapis.com/", +"location": "asia-east2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.asia-northeast1.rep.googleapis.com/", +"location": "asia-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.asia-northeast2.rep.googleapis.com/", +"location": "asia-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.asia-northeast3.rep.googleapis.com/", +"location": "asia-northeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.asia-south1.rep.googleapis.com/", +"location": "asia-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.asia-south2.rep.googleapis.com/", +"location": "asia-south2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.asia-southeast1.rep.googleapis.com/", +"location": "asia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.asia-southeast2.rep.googleapis.com/", +"location": "asia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.australia-southeast1.rep.googleapis.com/", +"location": "australia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.australia-southeast2.rep.googleapis.com/", +"location": "australia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.europe-central2.rep.googleapis.com/", +"location": "europe-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.europe-north1.rep.googleapis.com/", +"location": "europe-north1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.europe-north2.rep.googleapis.com/", +"location": "europe-north2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.europe-southwest1.rep.googleapis.com/", +"location": "europe-southwest1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.europe-west1.rep.googleapis.com/", +"location": "europe-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.europe-west10.rep.googleapis.com/", +"location": "europe-west10" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.europe-west12.rep.googleapis.com/", +"location": "europe-west12" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.europe-west2.rep.googleapis.com/", +"location": "europe-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.europe-west3.rep.googleapis.com/", +"location": "europe-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.europe-west4.rep.googleapis.com/", +"location": "europe-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.europe-west6.rep.googleapis.com/", +"location": "europe-west6" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.europe-west8.rep.googleapis.com/", +"location": "europe-west8" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.europe-west9.rep.googleapis.com/", +"location": "europe-west9" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.me-central1.rep.googleapis.com/", +"location": "me-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.me-central2.rep.googleapis.com/", +"location": "me-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.me-west1.rep.googleapis.com/", +"location": "me-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.northamerica-northeast1.rep.googleapis.com/", +"location": "northamerica-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.northamerica-northeast2.rep.googleapis.com/", +"location": "northamerica-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.northamerica-south1.rep.googleapis.com/", +"location": "northamerica-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.southamerica-east1.rep.googleapis.com/", +"location": "southamerica-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.southamerica-west1.rep.googleapis.com/", +"location": "southamerica-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.us-central1.rep.googleapis.com/", +"location": "us-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.us-east1.rep.googleapis.com/", +"location": "us-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.us-east4.rep.googleapis.com/", +"location": "us-east4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.us-east5.rep.googleapis.com/", +"location": "us-east5" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://firestore.us-east7.rep.googleapis.com/", "location": "us-east7" }, { "description": "Regional Endpoint", +"endpointUrl": "https://firestore.us-south1.rep.googleapis.com/", +"location": "us-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.us-west1.rep.googleapis.com/", +"location": "us-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.us-west2.rep.googleapis.com/", +"location": "us-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.us-west3.rep.googleapis.com/", +"location": "us-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.us-west4.rep.googleapis.com/", +"location": "us-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.us-west8.rep.googleapis.com/", +"location": "us-west8" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.africa-south1.rep.googleapis.com/", +"location": "africa-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.asia-east1.rep.googleapis.com/", +"location": "asia-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.asia-east2.rep.googleapis.com/", +"location": "asia-east2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.asia-northeast1.rep.googleapis.com/", +"location": "asia-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.asia-northeast2.rep.googleapis.com/", +"location": "asia-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.asia-northeast3.rep.googleapis.com/", +"location": "asia-northeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.asia-south1.rep.googleapis.com/", +"location": "asia-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.asia-south2.rep.googleapis.com/", +"location": "asia-south2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.asia-southeast1.rep.googleapis.com/", +"location": "asia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.asia-southeast2.rep.googleapis.com/", +"location": "asia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.australia-southeast1.rep.googleapis.com/", +"location": "australia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.australia-southeast2.rep.googleapis.com/", +"location": "australia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.europe-central2.rep.googleapis.com/", +"location": "europe-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.europe-north1.rep.googleapis.com/", +"location": "europe-north1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.europe-north2.rep.googleapis.com/", +"location": "europe-north2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.europe-southwest1.rep.googleapis.com/", +"location": "europe-southwest1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.europe-west1.rep.googleapis.com/", +"location": "europe-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.europe-west10.rep.googleapis.com/", +"location": "europe-west10" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.europe-west12.rep.googleapis.com/", +"location": "europe-west12" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.europe-west2.rep.googleapis.com/", +"location": "europe-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.europe-west3.rep.googleapis.com/", +"location": "europe-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.europe-west4.rep.googleapis.com/", +"location": "europe-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.europe-west6.rep.googleapis.com/", +"location": "europe-west6" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.europe-west8.rep.googleapis.com/", +"location": "europe-west8" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.europe-west9.rep.googleapis.com/", +"location": "europe-west9" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.me-central1.rep.googleapis.com/", +"location": "me-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.me-central2.rep.googleapis.com/", +"location": "me-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.me-west1.rep.googleapis.com/", +"location": "me-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.northamerica-northeast1.rep.googleapis.com/", +"location": "northamerica-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.northamerica-northeast2.rep.googleapis.com/", +"location": "northamerica-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.northamerica-south1.rep.googleapis.com/", +"location": "northamerica-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.southamerica-east1.rep.googleapis.com/", +"location": "southamerica-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.southamerica-west1.rep.googleapis.com/", +"location": "southamerica-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.us-central1.rep.googleapis.com/", +"location": "us-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.us-east1.rep.googleapis.com/", +"location": "us-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.us-east4.rep.googleapis.com/", +"location": "us-east4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.us-east5.rep.googleapis.com/", +"location": "us-east5" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://batch-firestore.us-east7.rep.googleapis.com/", "location": "us-east7" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.us-south1.rep.googleapis.com/", +"location": "us-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.us-west1.rep.googleapis.com/", +"location": "us-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.us-west2.rep.googleapis.com/", +"location": "us-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.us-west3.rep.googleapis.com/", +"location": "us-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.us-west4.rep.googleapis.com/", +"location": "us-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.us-west8.rep.googleapis.com/", +"location": "us-west8" } ], "fullyEncodeReservedExpansion": true, @@ -962,7 +1392,7 @@ } } }, -"revision": "20250830", +"revision": "20250918", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { diff --git a/googleapiclient/discovery_cache/documents/firestore.v1beta2.json b/googleapiclient/discovery_cache/documents/firestore.v1beta2.json index b835cdbb170..1959f33802a 100644 --- a/googleapiclient/discovery_cache/documents/firestore.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/firestore.v1beta2.json @@ -21,13 +21,443 @@ "endpoints": [ { "description": "Regional Endpoint", +"endpointUrl": "https://firestore.africa-south1.rep.googleapis.com/", +"location": "africa-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.asia-east1.rep.googleapis.com/", +"location": "asia-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.asia-east2.rep.googleapis.com/", +"location": "asia-east2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.asia-northeast1.rep.googleapis.com/", +"location": "asia-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.asia-northeast2.rep.googleapis.com/", +"location": "asia-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.asia-northeast3.rep.googleapis.com/", +"location": "asia-northeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.asia-south1.rep.googleapis.com/", +"location": "asia-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.asia-south2.rep.googleapis.com/", +"location": "asia-south2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.asia-southeast1.rep.googleapis.com/", +"location": "asia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.asia-southeast2.rep.googleapis.com/", +"location": "asia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.australia-southeast1.rep.googleapis.com/", +"location": "australia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.australia-southeast2.rep.googleapis.com/", +"location": "australia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.europe-central2.rep.googleapis.com/", +"location": "europe-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.europe-north1.rep.googleapis.com/", +"location": "europe-north1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.europe-north2.rep.googleapis.com/", +"location": "europe-north2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.europe-southwest1.rep.googleapis.com/", +"location": "europe-southwest1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.europe-west1.rep.googleapis.com/", +"location": "europe-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.europe-west10.rep.googleapis.com/", +"location": "europe-west10" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.europe-west12.rep.googleapis.com/", +"location": "europe-west12" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.europe-west2.rep.googleapis.com/", +"location": "europe-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.europe-west3.rep.googleapis.com/", +"location": "europe-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.europe-west4.rep.googleapis.com/", +"location": "europe-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.europe-west6.rep.googleapis.com/", +"location": "europe-west6" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.europe-west8.rep.googleapis.com/", +"location": "europe-west8" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.europe-west9.rep.googleapis.com/", +"location": "europe-west9" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.me-central1.rep.googleapis.com/", +"location": "me-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.me-central2.rep.googleapis.com/", +"location": "me-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.me-west1.rep.googleapis.com/", +"location": "me-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.northamerica-northeast1.rep.googleapis.com/", +"location": "northamerica-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.northamerica-northeast2.rep.googleapis.com/", +"location": "northamerica-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.northamerica-south1.rep.googleapis.com/", +"location": "northamerica-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.southamerica-east1.rep.googleapis.com/", +"location": "southamerica-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.southamerica-west1.rep.googleapis.com/", +"location": "southamerica-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.us-central1.rep.googleapis.com/", +"location": "us-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.us-east1.rep.googleapis.com/", +"location": "us-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.us-east4.rep.googleapis.com/", +"location": "us-east4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.us-east5.rep.googleapis.com/", +"location": "us-east5" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://firestore.us-east7.rep.googleapis.com/", "location": "us-east7" }, { "description": "Regional Endpoint", +"endpointUrl": "https://firestore.us-south1.rep.googleapis.com/", +"location": "us-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.us-west1.rep.googleapis.com/", +"location": "us-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.us-west2.rep.googleapis.com/", +"location": "us-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.us-west3.rep.googleapis.com/", +"location": "us-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.us-west4.rep.googleapis.com/", +"location": "us-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://firestore.us-west8.rep.googleapis.com/", +"location": "us-west8" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.africa-south1.rep.googleapis.com/", +"location": "africa-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.asia-east1.rep.googleapis.com/", +"location": "asia-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.asia-east2.rep.googleapis.com/", +"location": "asia-east2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.asia-northeast1.rep.googleapis.com/", +"location": "asia-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.asia-northeast2.rep.googleapis.com/", +"location": "asia-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.asia-northeast3.rep.googleapis.com/", +"location": "asia-northeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.asia-south1.rep.googleapis.com/", +"location": "asia-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.asia-south2.rep.googleapis.com/", +"location": "asia-south2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.asia-southeast1.rep.googleapis.com/", +"location": "asia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.asia-southeast2.rep.googleapis.com/", +"location": "asia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.australia-southeast1.rep.googleapis.com/", +"location": "australia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.australia-southeast2.rep.googleapis.com/", +"location": "australia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.europe-central2.rep.googleapis.com/", +"location": "europe-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.europe-north1.rep.googleapis.com/", +"location": "europe-north1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.europe-north2.rep.googleapis.com/", +"location": "europe-north2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.europe-southwest1.rep.googleapis.com/", +"location": "europe-southwest1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.europe-west1.rep.googleapis.com/", +"location": "europe-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.europe-west10.rep.googleapis.com/", +"location": "europe-west10" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.europe-west12.rep.googleapis.com/", +"location": "europe-west12" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.europe-west2.rep.googleapis.com/", +"location": "europe-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.europe-west3.rep.googleapis.com/", +"location": "europe-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.europe-west4.rep.googleapis.com/", +"location": "europe-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.europe-west6.rep.googleapis.com/", +"location": "europe-west6" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.europe-west8.rep.googleapis.com/", +"location": "europe-west8" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.europe-west9.rep.googleapis.com/", +"location": "europe-west9" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.me-central1.rep.googleapis.com/", +"location": "me-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.me-central2.rep.googleapis.com/", +"location": "me-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.me-west1.rep.googleapis.com/", +"location": "me-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.northamerica-northeast1.rep.googleapis.com/", +"location": "northamerica-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.northamerica-northeast2.rep.googleapis.com/", +"location": "northamerica-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.northamerica-south1.rep.googleapis.com/", +"location": "northamerica-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.southamerica-east1.rep.googleapis.com/", +"location": "southamerica-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.southamerica-west1.rep.googleapis.com/", +"location": "southamerica-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.us-central1.rep.googleapis.com/", +"location": "us-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.us-east1.rep.googleapis.com/", +"location": "us-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.us-east4.rep.googleapis.com/", +"location": "us-east4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.us-east5.rep.googleapis.com/", +"location": "us-east5" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://batch-firestore.us-east7.rep.googleapis.com/", "location": "us-east7" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.us-south1.rep.googleapis.com/", +"location": "us-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.us-west1.rep.googleapis.com/", +"location": "us-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.us-west2.rep.googleapis.com/", +"location": "us-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.us-west3.rep.googleapis.com/", +"location": "us-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.us-west4.rep.googleapis.com/", +"location": "us-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://batch-firestore.us-west8.rep.googleapis.com/", +"location": "us-west8" } ], "fullyEncodeReservedExpansion": true, @@ -427,7 +857,7 @@ } } }, -"revision": "20250830", +"revision": "20250918", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Empty": { From 079eeee6fb972c9e5cd595dff5b51d1e0530217a Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 30 Sep 2025 07:09:36 +0000 Subject: [PATCH 24/42] fix(iamcredentials): update the api #### iamcredentials:v1 The following keys were changed: - endpoints (Total Keys: 1) --- .../discovery_cache/documents/iamcredentials.v1.json | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/googleapiclient/discovery_cache/documents/iamcredentials.v1.json b/googleapiclient/discovery_cache/documents/iamcredentials.v1.json index 64870a6b311..b16a18bf486 100644 --- a/googleapiclient/discovery_cache/documents/iamcredentials.v1.json +++ b/googleapiclient/discovery_cache/documents/iamcredentials.v1.json @@ -40,6 +40,11 @@ "description": "Regional Endpoint", "endpointUrl": "https://iamcredentials.us-east7.rep.googleapis.com/", "location": "us-east7" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iamcredentials.us-west1.rep.googleapis.com/", +"location": "us-west1" } ], "fullyEncodeReservedExpansion": true, @@ -335,7 +340,7 @@ } } }, -"revision": "20250717", +"revision": "20250911", "rootUrl": "https://iamcredentials.googleapis.com/", "schemas": { "GenerateAccessTokenRequest": { From 7a2c0b6536835c43371a11eaf499c86f11b4e398 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 30 Sep 2025 07:09:36 +0000 Subject: [PATCH 25/42] feat(integrations): update the api #### integrations:v1 The following keys were added: - resources.projects.resources.locations.resources.integrations.resources.versions.methods.test (Total Keys: 12) --- ...jects.locations.integrations.versions.html | 1281 +++++++++++++++++ .../documents/integrations.v1.json | 30 +- 2 files changed, 1310 insertions(+), 1 deletion(-) diff --git a/docs/dyn/integrations_v1.projects.locations.integrations.versions.html b/docs/dyn/integrations_v1.projects.locations.integrations.versions.html index 009b79170a4..9b428a11e3c 100644 --- a/docs/dyn/integrations_v1.projects.locations.integrations.versions.html +++ b/docs/dyn/integrations_v1.projects.locations.integrations.versions.html @@ -109,6 +109,9 @@

Instance Methods

publish(name, body=None, x__xgafv=None)

This RPC throws an exception if the integration is in ARCHIVED or ACTIVE state. This RPC throws an exception if the version being published is DRAFT, and if the `locked_by` user is not the same as the user performing the Publish. Audit fields updated include last_published_timestamp, last_published_by, last_modified_timestamp, last_modified_by. Any existing lock is on this integration is released.

+

+ test(name, body=None, x__xgafv=None)

+

Execute the integration in draft state

unpublish(name, body=None, x__xgafv=None)

Sets the status of the ACTIVE integration to SNAPSHOT with a new tag "PREVIOUSLY_PUBLISHED" after validating it. The "HEAD" and "PUBLISH_REQUESTED" tags do not change. This RPC throws an exception if the version being snapshot is not ACTIVE. Audit fields added include action, action_by, action_timestamp.

@@ -7626,6 +7629,1284 @@

Method Details

} +
+ test(name, body=None, x__xgafv=None) + 
Execute the integration in draft state
+
+Args:
+  name: string, Output only. Auto-generated primary key. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The request for testing an integration.
+  "clientId": "A String", # Required. This is used to identify the client on whose behalf the event will be executed.
+  "configParameters": { # Optional. Config parameters used during integration execution.
+    "a_key": "", # Properties of the object.
+  },
+  "deadlineSecondsTime": "A String", # Optional. custom deadline of the rpc
+  "inputParameters": { # Optional. Input parameters used during integration execution.
+    "a_key": { # The type of the parameter.
+      "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+        "booleanValues": [ # Boolean array.
+          True or False,
+        ],
+      },
+      "booleanValue": True or False, # Boolean.
+      "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+        "doubleValues": [ # Double number array.
+          3.14,
+        ],
+      },
+      "doubleValue": 3.14, # Double Number.
+      "intArray": { # This message only contains a field of integer array. # Integer Array.
+        "intValues": [ # Integer array.
+          "A String",
+        ],
+      },
+      "intValue": "A String", # Integer.
+      "jsonValue": "A String", # Json.
+      "stringArray": { # This message only contains a field of string array. # String Array.
+        "stringValues": [ # String array.
+          "A String",
+        ],
+      },
+      "stringValue": "A String", # String.
+    },
+  },
+  "integrationVersion": { # The integration version definition. # Required. integration config to execute the workflow
+    "cloudKmsKey": "A String", # Optional. Cloud KMS resource name for the CMEK encryption key.
+    "cloudLoggingDetails": { # Cloud Logging details for execution info # Optional. Cloud Logging details for the integration version
+      "cloudLoggingSeverity": "A String", # Optional. Severity selected by the customer for the logs to be sent to Cloud Logging, for the integration version getting executed.
+      "enableCloudLogging": True or False, # Optional. Status of whether Cloud Logging is enabled or not for the integration version getting executed.
+    },
+    "createTime": "A String", # Output only. Auto-generated.
+    "createdFromTemplate": "A String", # Optional. Optional. The resource name of the template from which the integration is created.
+    "databasePersistencePolicy": "A String", # Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index.
+    "description": "A String", # Optional. The integration description.
+    "enableVariableMasking": True or False, # Optional. True if variable masking feature should be turned on for this version
+    "errorCatcherConfigs": [ # Optional. Error Catch Task configuration for the integration. It's optional.
+      { # Configuration detail of a error catch task
+        "description": "A String", # Optional. User-provided description intended to give more business context about the error catcher config.
+        "errorCatcherId": "A String", # Required. An error catcher id is string representation for the error catcher config. Within a workflow, error_catcher_id uniquely identifies an error catcher config among all error catcher configs for the workflow
+        "errorCatcherNumber": "A String", # Required. A number to uniquely identify each error catcher config within the workflow on UI.
+        "label": "A String", # Optional. The user created label for a particular error catcher. Optional.
+        "position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI.
+          "x": 42, # Required. X axis of the coordinate
+          "y": 42, # Required. Y axis of the coordinate
+        },
+        "startErrorTasks": [ # Required. The set of start tasks that are to be executed for the error catch flow
+          { # The task that is next in line to be executed, if the condition specified evaluated to true.
+            "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+            "description": "A String", # User-provided description intended to give additional business context about the task.
+            "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+            "taskConfigId": "A String", # ID of the next task.
+            "taskId": "A String", # Task number of the next task.
+          },
+        ],
+      },
+    ],
+    "integrationConfigParameters": [ # Optional. Config Parameters that are expected to be passed to the integration when an integration is published. This consists of all the parameters that are expected to provide configuration in the integration execution. This gives the user the ability to provide default values, value, add information like connection url, project based configuration value and also provide data types of each parameter.
+      { # Integration Config Parameter is defined in the integration config and are used to provide external configuration for integration. It provide information about data types of the expected parameters and provide any default values or value. They can also be used to add custom attributes.
+        "parameter": { # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition. # Optional. Integration Parameter to provide the default value, data type and attributes required for the Integration config variables.
+          "containsLargeData": True or False, # Indicates whether this variable contains large data and need to be uploaded to Cloud Storage.
+          "dataType": "A String", # Type of the parameter.
+          "defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+            "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+              "booleanValues": [ # Boolean array.
+                True or False,
+              ],
+            },
+            "booleanValue": True or False, # Boolean.
+            "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+              "doubleValues": [ # Double number array.
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14, # Double Number.
+            "intArray": { # This message only contains a field of integer array. # Integer Array.
+              "intValues": [ # Integer array.
+                "A String",
+              ],
+            },
+            "intValue": "A String", # Integer.
+            "jsonValue": "A String", # Json.
+            "stringArray": { # This message only contains a field of string array. # String Array.
+              "stringValues": [ # String array.
+                "A String",
+              ],
+            },
+            "stringValue": "A String", # String.
+          },
+          "description": "A String", # Optional. Description of the parameter.
+          "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+          "inputOutputType": "A String", # Specifies the input/output type for the parameter.
+          "isTransient": True or False, # Whether this parameter is a transient parameter.
+          "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+          "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+          "masked": True or False, # True if this parameter should be masked in the logs
+          "producer": "A String", # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+          "searchable": True or False, # Searchable in the execution log or not.
+        },
+        "value": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+          "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+            "booleanValues": [ # Boolean array.
+              True or False,
+            ],
+          },
+          "booleanValue": True or False, # Boolean.
+          "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+            "doubleValues": [ # Double number array.
+              3.14,
+            ],
+          },
+          "doubleValue": 3.14, # Double Number.
+          "intArray": { # This message only contains a field of integer array. # Integer Array.
+            "intValues": [ # Integer array.
+              "A String",
+            ],
+          },
+          "intValue": "A String", # Integer.
+          "jsonValue": "A String", # Json.
+          "stringArray": { # This message only contains a field of string array. # String Array.
+            "stringValues": [ # String array.
+              "A String",
+            ],
+          },
+          "stringValue": "A String", # String.
+        },
+      },
+    ],
+    "integrationParameters": [ # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+      { # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.
+        "containsLargeData": True or False, # Indicates whether this variable contains large data and need to be uploaded to Cloud Storage.
+        "dataType": "A String", # Type of the parameter.
+        "defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+          "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+            "booleanValues": [ # Boolean array.
+              True or False,
+            ],
+          },
+          "booleanValue": True or False, # Boolean.
+          "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+            "doubleValues": [ # Double number array.
+              3.14,
+            ],
+          },
+          "doubleValue": 3.14, # Double Number.
+          "intArray": { # This message only contains a field of integer array. # Integer Array.
+            "intValues": [ # Integer array.
+              "A String",
+            ],
+          },
+          "intValue": "A String", # Integer.
+          "jsonValue": "A String", # Json.
+          "stringArray": { # This message only contains a field of string array. # String Array.
+            "stringValues": [ # String array.
+              "A String",
+            ],
+          },
+          "stringValue": "A String", # String.
+        },
+        "description": "A String", # Optional. Description of the parameter.
+        "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+        "inputOutputType": "A String", # Specifies the input/output type for the parameter.
+        "isTransient": True or False, # Whether this parameter is a transient parameter.
+        "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+        "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+        "masked": True or False, # True if this parameter should be masked in the logs
+        "producer": "A String", # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+        "searchable": True or False, # Searchable in the execution log or not.
+      },
+    ],
+    "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+      "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution.
+        {
+          "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters.
+            "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...)
+            "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults.
+              "booleanValue": True or False,
+              "doubleArray": {
+                "values": [
+                  3.14,
+                ],
+              },
+              "doubleValue": 3.14,
+              "intArray": {
+                "values": [
+                  "A String",
+                ],
+              },
+              "intValue": "A String",
+              "protoValue": {
+                "a_key": "", # Properties of the object. Contains field @type with type URL.
+              },
+              "stringArray": {
+                "values": [
+                  "A String",
+                ],
+              },
+              "stringValue": "A String",
+            },
+            "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered.
+            "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable.
+            "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See
+              "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key.
+              "seedPeriod": "A String",
+              "seedScope": "A String",
+            },
+            "masked": True or False, # True if this workflow parameter should be masked in the logs
+            "readOnly": True or False, # Used to indicate if the ParameterEntry is a read only field or not.
+            "searchable": "A String",
+            "taskVisibility": [ # List of tasks that can view this property, if empty then all.
+              "A String",
+            ],
+          },
+          "children": [ # Child parameters nested within this parameter. This field only applies to protobuf parameters
+            # Object with schema name: EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry
+          ],
+          "containsLargeData": True or False, # Indicates whether this variable contains large data and need to be uploaded to Cloud Storage.
+          "dataType": "A String", # The data type of the parameter.
+          "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+            "booleanArray": {
+              "booleanValues": [
+                True or False,
+              ],
+            },
+            "booleanValue": True or False,
+            "doubleArray": {
+              "doubleValues": [
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14,
+            "intArray": {
+              "intValues": [
+                "A String",
+              ],
+            },
+            "intValue": "A String",
+            "jsonValue": "A String",
+            "protoArray": {
+              "protoValues": [
+                {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+              ],
+            },
+            "protoValue": {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+            "serializedObjectValue": {
+              "objectValue": "A String",
+            },
+            "stringArray": {
+              "stringValues": [
+                "A String",
+              ],
+            },
+            "stringValue": "A String",
+          },
+          "description": "A String", # Optional. The description about the parameter
+          "inOutType": "A String", # Specifies the input/output type for the parameter.
+          "isTransient": True or False, # Whether this parameter is a transient parameter.
+          "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+          "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+          "name": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+          "producedBy": { # Represents a node identifier (type + id). Next highest id: 3 # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+            "elementIdentifier": "A String", # Configuration of the edge.
+            "elementType": "A String", # Destination node where the edge ends. It can only be a task config.
+          },
+          "producer": "A String",
+          "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type.
+          "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry".
+          "required": True or False,
+        },
+      ],
+    },
+    "lastModifierEmail": "A String", # Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+    "lockHolder": "A String", # Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+    "name": "A String", # Output only. Auto-generated primary key.
+    "origin": "A String", # Optional. The origin that indicates where this integration is coming from.
+    "parentTemplateId": "A String", # Optional. The id of the template which was used to create this integration_version.
+    "runAsServiceAccount": "A String", # Optional. The run-as service account email, if set and auth config is not configured, that will be used to generate auth token to be used in Connector task, Rest caller task and Cloud function task.
+    "snapshotNumber": "A String", # Output only. An increasing sequence that is set when a new snapshot is created. The last created snapshot can be identified by [workflow_name, org_id latest(snapshot_number)]. However, last created snapshot need not be same as the HEAD. So users should always use "HEAD" tag to identify the head.
+    "state": "A String", # Output only. User should not set it as an input.
+    "status": "A String", # Output only. Generated by eventbus. User should not set it as an input.
+    "taskConfigs": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+      { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.
+        "conditionalFailurePolicies": { # Conditional task failur retry strategies # Optional. The list of conditional failure policies that will be applied to the task in order.
+          "defaultFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # The default failure policy to be applied if no conditional failure policy matches.
+            "condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
+            "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+            "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+            "retryStrategy": "A String", # Defines what happens to the task upon failure.
+          },
+          "failurePolicies": [ # The list of failure policies that will be applied to the task in order.
+            { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied).
+              "condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
+              "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+              "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+              "retryStrategy": "A String", # Defines what happens to the task upon failure.
+            },
+          ],
+        },
+        "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+        "displayName": "A String", # Optional. User-provided label that is attached to this TaskConfig in the UI.
+        "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
+        "externalTaskType": "A String", # Optional. External task type of the task
+        "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+          "condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
+          "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+          "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+          "retryStrategy": "A String", # Defines what happens to the task upon failure.
+        },
+        "jsonValidationOption": "A String", # Optional. If set, overrides the option configured in the Task implementation class.
+        "nextTasks": [ # Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+          { # The task that is next in line to be executed, if the condition specified evaluated to true.
+            "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+            "description": "A String", # User-provided description intended to give additional business context about the task.
+            "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+            "taskConfigId": "A String", # ID of the next task.
+            "taskId": "A String", # Task number of the next task.
+          },
+        ],
+        "nextTasksExecutionPolicy": "A String", # Optional. The policy dictating the execution of the next set of tasks for the current task.
+        "parameters": { # Optional. The customized parameters the user can pass to this task.
+          "a_key": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Next available id: 4
+            "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+            "masked": True or False, # True if this parameter should be masked in the logs
+            "value": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+              "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                "booleanValues": [ # Boolean array.
+                  True or False,
+                ],
+              },
+              "booleanValue": True or False, # Boolean.
+              "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                "doubleValues": [ # Double number array.
+                  3.14,
+                ],
+              },
+              "doubleValue": 3.14, # Double Number.
+              "intArray": { # This message only contains a field of integer array. # Integer Array.
+                "intValues": [ # Integer array.
+                  "A String",
+                ],
+              },
+              "intValue": "A String", # Integer.
+              "jsonValue": "A String", # Json.
+              "stringArray": { # This message only contains a field of string array. # String Array.
+                "stringValues": [ # String array.
+                  "A String",
+                ],
+              },
+              "stringValue": "A String", # String.
+            },
+          },
+        },
+        "position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI.
+          "x": 42, # Required. X axis of the coordinate
+          "y": 42, # Required. Y axis of the coordinate
+        },
+        "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Optional. Determines what action to take upon successful task completion.
+          "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+        },
+        "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+          "condition": "A String", # Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.
+          "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+          "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+          "retryStrategy": "A String", # Defines what happens to the task upon failure.
+        },
+        "task": "A String", # Optional. The name for the task.
+        "taskExecutionStrategy": "A String", # Optional. The policy dictating the execution strategy of this task.
+        "taskId": "A String", # Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).
+        "taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template
+      },
+    ],
+    "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+      { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.
+        "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc.
+          { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event.
+            "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week).
+            "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+            "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow.
+            "clientId": "A String", # Client associated with this alert configuration. Must be a client enabled in one of the containing workflow's triggers.
+            "durationThresholdMs": "A String", # Should be specified only for TASK_AVERAGE_DURATION and TASK_PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+            "errorEnumList": { # List of error enums for alerts.
+              "enumStrings": [
+                "A String",
+              ],
+              "filterType": "A String",
+            },
+            "metricType": "A String",
+            "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+            "onlyFinalAttempt": True or False, # Only count final task attempts, not retries.
+            "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+            "thresholdType": "A String", # The threshold type for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+            "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. # The metric value, above or below which the alert should be triggered.
+              "absolute": "A String",
+              "percentage": 42,
+            },
+            "warningEnumList": { # List of error enums for alerts.
+              "enumStrings": [
+                "A String",
+              ],
+              "filterType": "A String",
+            },
+          },
+        ],
+        "conditionalFailurePolicies": { # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+          "defaultFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # The default failure policy to be applied if no conditional failure policy matches
+            "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+            "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+            "retryCondition": "A String", # Optional. The retry condition that will be evaluated for this failure policy with the corresponding retry strategy.
+            "retryStrategy": "A String", # Defines what happens to the task upon failure.
+          },
+          "failurePolicies": [ # The list of failure policies that will be applied to the task in order.
+            { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied).
+              "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+              "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+              "retryCondition": "A String", # Optional. The retry condition that will be evaluated for this failure policy with the corresponding retry strategy.
+              "retryStrategy": "A String", # Defines what happens to the task upon failure.
+            },
+          ],
+        },
+        "createTime": "A String", # Auto-generated.
+        "creatorEmail": "A String", # The creator's email address. Auto-generated from the user's email.
+        "description": "A String", # User-provided description intended to give more business context about the task.
+        "disableStrictTypeValidation": True or False, # If this config contains a TypedTask, allow validation to succeed if an input is read from the output of another TypedTask whose output type is declared as a superclass of the requested input type. For instance, if the previous task declares an output of type Message, any task with this flag enabled will pass validation when attempting to read any proto Message type from the resultant Event parameter.
+        "errorCatcherId": "A String", # Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
+        "externalTaskType": "A String",
+        "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+          "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+          "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+          "retryCondition": "A String", # Optional. The retry condition that will be evaluated for this failure policy with the corresponding retry strategy.
+          "retryStrategy": "A String", # Defines what happens to the task upon failure.
+        },
+        "incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
+        "jsonValidationOption": "A String", # If set, overrides the option configured in the Task implementation class.
+        "label": "A String", # User-provided label that is attached to this TaskConfig in the UI.
+        "lastModifiedTime": "A String", # Auto-generated.
+        "nextTasks": [ # The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+          { # The task that is next in line to be executed, if the condition specified evaluated to true.
+            "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+              { # This message recursively combines constituent conditions using logical AND.
+                "conditions": [ # A set of individual constituent conditions.
+                  { # Condition that uses `operator` to evaluate the key against the value.
+                    "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+                    "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+                    "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+                      "booleanValue": True or False,
+                      "doubleArray": {
+                        "values": [
+                          3.14,
+                        ],
+                      },
+                      "doubleValue": 3.14,
+                      "intArray": {
+                        "values": [
+                          "A String",
+                        ],
+                      },
+                      "intValue": "A String",
+                      "protoValue": {
+                        "a_key": "", # Properties of the object. Contains field @type with type URL.
+                      },
+                      "stringArray": {
+                        "values": [
+                          "A String",
+                        ],
+                      },
+                      "stringValue": "A String",
+                    },
+                  },
+                ],
+              },
+            ],
+            "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+            "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+            "label": "A String", # User-provided label that is attached to this edge in the UI.
+            "taskConfigId": "A String", # ID of the next task.
+            "taskNumber": "A String", # Task number of the next task.
+          },
+        ],
+        "nextTasksExecutionPolicy": "A String", # The policy dictating the execution of the next set of tasks for the current task.
+        "parameters": { # The customized parameters the user can pass to this task.
+          "a_key": { # Key-value pair of EventBus parameters.
+            "dataType": "A String", # Explicitly getting the type of the parameter.
+            "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+            "masked": True or False, # True if this parameter should be masked in the logs
+            "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+              "booleanArray": {
+                "booleanValues": [
+                  True or False,
+                ],
+              },
+              "booleanValue": True or False,
+              "doubleArray": {
+                "doubleValues": [
+                  3.14,
+                ],
+              },
+              "doubleValue": 3.14,
+              "intArray": {
+                "intValues": [
+                  "A String",
+                ],
+              },
+              "intValue": "A String",
+              "jsonValue": "A String",
+              "protoArray": {
+                "protoValues": [
+                  {
+                    "a_key": "", # Properties of the object. Contains field @type with type URL.
+                  },
+                ],
+              },
+              "protoValue": {
+                "a_key": "", # Properties of the object. Contains field @type with type URL.
+              },
+              "serializedObjectValue": {
+                "objectValue": "A String",
+              },
+              "stringArray": {
+                "stringValues": [
+                  "A String",
+                ],
+              },
+              "stringValue": "A String",
+            },
+          },
+        },
+        "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this task config on the UI.
+          "x": 42,
+          "y": 42,
+        },
+        "precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task.
+        "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI.
+        "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times).
+          "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Optional. The customized parameters the user can pass to this task.
+            "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+              { # Key-value pair of EventBus parameters.
+                "dataType": "A String", # Explicitly getting the type of the parameter.
+                "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+                "masked": True or False, # True if this parameter should be masked in the logs
+                "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                  "booleanArray": {
+                    "booleanValues": [
+                      True or False,
+                    ],
+                  },
+                  "booleanValue": True or False,
+                  "doubleArray": {
+                    "doubleValues": [
+                      3.14,
+                    ],
+                  },
+                  "doubleValue": 3.14,
+                  "intArray": {
+                    "intValues": [
+                      "A String",
+                    ],
+                  },
+                  "intValue": "A String",
+                  "jsonValue": "A String",
+                  "protoArray": {
+                    "protoValues": [
+                      {
+                        "a_key": "", # Properties of the object. Contains field @type with type URL.
+                      },
+                    ],
+                  },
+                  "protoValue": {
+                    "a_key": "", # Properties of the object. Contains field @type with type URL.
+                  },
+                  "serializedObjectValue": {
+                    "objectValue": "A String",
+                  },
+                  "stringArray": {
+                    "stringValues": [
+                      "A String",
+                    ],
+                  },
+                  "stringValue": "A String",
+                },
+              },
+            ],
+          },
+          "rollbackTaskImplementationClassName": "A String", # Required. This is the name of the task that needs to be executed upon rollback of this task.
+          "taskNumbersToRollback": [ # Required. These are the tasks numbers of the tasks whose `rollback_strategy.rollback_task_implementation_class_name` needs to be executed upon failure of this task.
+            "A String",
+          ],
+        },
+        "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Determines what action to take upon successful task completion.
+          "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+        },
+        "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+          "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+          "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+          "retryCondition": "A String", # Optional. The retry condition that will be evaluated for this failure policy with the corresponding retry strategy.
+          "retryStrategy": "A String", # Defines what happens to the task upon failure.
+        },
+        "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
+          "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc
+          "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. # Metadata inclueds the task name, author and so on.
+            "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name.
+            "admins": [
+              { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar.
+                "googleGroupEmail": "A String",
+                "userEmail": "A String",
+              },
+            ],
+            "category": "A String",
+            "codeSearchLink": "A String", # The Code Search link to the Task Java file.
+            "defaultJsonValidationOption": "A String", # Controls whether JSON workflow parameters are validated against provided schemas before and/or after this task's execution.
+            "defaultSpec": "A String", # Contains the initial configuration of the task with default values set. For now, The string should be compatible to an ASCII-proto format.
+            "description": "A String", # In a few sentences, describe the purpose and usage of the task.
+            "descriptiveName": "A String", # The string name to show on the task list on the Workflow editor screen. This should be a very short, one to two words name for the task. (e.g. "Send Mail")
+            "docMarkdown": "A String", # Snippet of markdown documentation to embed in the RHP for this task.
+            "externalCategory": "A String",
+            "externalCategorySequence": 42, # Sequence with which the task in specific category to be displayed in task discovery panel for external users.
+            "externalDocHtml": "A String", # External-facing documention embedded in the RHP for this task.
+            "externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc).
+            "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html.
+            "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available
+            "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format.
+            "isDeprecated": True or False, # The deprecation status of the current task. Default value is false;
+            "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class.
+            "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html
+            "status": "A String", # Allows author to indicate if the task is ready to use or not. If not set, then it will default to INACTIVE.
+            "system": "A String",
+            "tags": [ # A set of tags that pertain to a particular task. This can be used to improve the searchability of tasks with several names ("REST Caller" vs. "Call REST Endpoint") or to help users find tasks based on related words.
+              "A String",
+            ],
+          },
+          "paramSpecs": { # Declarations for inputs/outputs for a TypedTask. This is also associated with the METADATA mask.
+            "parameters": [
+              { # Key-value pair of EventBus task parameters. Next id: 13
+                "className": "A String", # The FQCN of the Java object this represents. A string, for example, would be "java.lang.String". If this is "java.lang.Object", the parameter can be of any type.
+                "collectionElementClassName": "A String", # If it is a collection of objects, this would be the FCQN of every individual element in the collection. If this is "java.lang.Object", the parameter is a collection of any type.
+                "config": { # Optional fields, such as help text and other useful info.
+                  "descriptivePhrase": "A String", # A short phrase to describe what this parameter contains.
+                  "helpText": "A String", # Detailed help text for this parameter containing information not provided elsewhere. For example, instructions on how to migrate from a deprecated parameter.
+                  "hideDefaultValue": True or False, # Whether the default value is hidden in the UI.
+                  "inputDisplayOption": "A String",
+                  "isHidden": True or False, # Whether this field is hidden in the UI.
+                  "label": "A String", # A user-friendly label for the parameter.
+                  "parameterNameOption": "A String",
+                  "subSectionLabel": "A String", # A user-friendly label for subSection under which the parameter will be displayed.
+                  "uiPlaceholderText": "A String", # Placeholder text which will appear in the UI input form for this parameter.
+                },
+                "dataType": "A String", # The data type of the parameter.
+                "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+                  "booleanArray": {
+                    "booleanValues": [
+                      True or False,
+                    ],
+                  },
+                  "booleanValue": True or False,
+                  "doubleArray": {
+                    "doubleValues": [
+                      3.14,
+                    ],
+                  },
+                  "doubleValue": 3.14,
+                  "intArray": {
+                    "intValues": [
+                      "A String",
+                    ],
+                  },
+                  "intValue": "A String",
+                  "jsonValue": "A String",
+                  "protoArray": {
+                    "protoValues": [
+                      {
+                        "a_key": "", # Properties of the object. Contains field @type with type URL.
+                      },
+                    ],
+                  },
+                  "protoValue": {
+                    "a_key": "", # Properties of the object. Contains field @type with type URL.
+                  },
+                  "serializedObjectValue": {
+                    "objectValue": "A String",
+                  },
+                  "stringArray": {
+                    "stringValues": [
+                      "A String",
+                    ],
+                  },
+                  "stringValue": "A String",
+                },
+                "isDeprecated": True or False, # If set, this entry is deprecated, so further use of this parameter should be prohibited.
+                "isOutput": True or False,
+                "jsonSchema": "A String", # If the data_type is JSON_VALUE, then this will define its schema.
+                "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given task. These parameters must be predefined in the workflow definition.
+                "protoDef": { # Populated if this represents a proto or proto array.
+                  "fullName": "A String", # The fully-qualified proto name. This message, for example, would be "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition".
+                  "path": "A String", # Path to the proto file that contains the message type's definition.
+                },
+                "required": True or False, # If set, the user must provide an input value for this parameter.
+                "validationRule": { # Rule used to validate inputs (individual values and collection elements) for this parameter.
+                  "doubleRange": { # Range used to validate doubles and floats.
+                    "max": 3.14, # The inclusive maximum of the acceptable range.
+                    "min": 3.14, # The inclusive minimum of the acceptable range.
+                  },
+                  "intRange": { # Range used to validate longs and ints.
+                    "max": "A String", # The inclusive maximum of the acceptable range.
+                    "min": "A String", # The inclusive minimum of the acceptable range.
+                  },
+                  "stringRegex": { # Rule used to validate strings.
+                    "exclusive": True or False, # Whether the regex matcher is applied exclusively (if true, matching values will be rejected).
+                    "regex": "A String", # The regex applied to the input value(s).
+                  },
+                },
+              },
+            ],
+          },
+          "stats": { # Stats for the requested dimensions: QPS, duration, and error/warning rate # Deprecated - statistics from the Monarch query.
+            "dimensions": { # Dimensions that these stats have been aggregated on.
+              "clientId": "A String",
+              "enumFilterType": "A String", # Whether to include or exclude the enums matching the regex.
+              "errorEnumString": "A String",
+              "retryAttempt": "A String",
+              "taskName": "A String",
+              "taskNumber": "A String",
+              "triggerId": "A String", # Stats have been or will be aggregated on set fields for any semantically-meaningful combination.
+              "warningEnumString": "A String",
+              "workflowId": "A String",
+              "workflowName": "A String",
+            },
+            "durationInSeconds": 3.14, # Average duration in seconds.
+            "errorRate": 3.14, # Average error rate.
+            "qps": 3.14, # Queries per second.
+            "warningRate": 3.14, # Average warning rate.
+          },
+          "taskType": "A String", # Defines the type of the task
+          "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: # UI configuration for this task Also associated with the METADATA mask.
+            "taskUiModuleConfigs": [ # Configurations of included config modules.
+              { # Task author would use this type to configure a config module.
+                "moduleId": "A String", # ID of the config module.
+              },
+            ],
+          },
+        },
+        "taskExecutionStrategy": "A String", # The policy dictating the execution strategy of this task.
+        "taskName": "A String", # The name for the task.
+        "taskNumber": "A String", # REQUIRED: the identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_number`).
+        "taskSpec": "A String", # A string template that allows user to configure task parameters (with either literal default values or tokens which will be resolved at execution time) for the task. It will eventually replace the old "parameters" field.
+        "taskTemplateName": "A String", # Used to define task-template name if task is of type task-template
+        "taskType": "A String", # Defines the type of the task
+      },
+    ],
+    "teardown": { # Optional. Contains a graph of tasks that will be executed before putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), regardless of success or failure, similar to "finally" in code.
+      "teardownTaskConfigs": [ # Required.
+        {
+          "creatorEmail": "A String", # The creator's email address.
+          "name": "A String", # Required. Unique identifier of the teardown task within this Config. We use this field as the identifier to find next teardown tasks.
+          "nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching).
+            "name": "A String", # Required. Name of the next teardown task.
+          },
+          "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # The parameters the user can pass to this task.
+            "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+              { # Key-value pair of EventBus parameters.
+                "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+                "masked": True or False, # True if this parameter should be masked in the logs
+                "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                  "booleanArray": {
+                    "booleanValues": [
+                      True or False,
+                    ],
+                  },
+                  "booleanValue": True or False,
+                  "doubleArray": {
+                    "doubleValues": [
+                      3.14,
+                    ],
+                  },
+                  "doubleValue": 3.14,
+                  "intArray": {
+                    "intValues": [
+                      "A String",
+                    ],
+                  },
+                  "intValue": "A String",
+                  "protoArray": {
+                    "protoValues": [
+                      {
+                        "a_key": "", # Properties of the object. Contains field @type with type URL.
+                      },
+                    ],
+                  },
+                  "protoValue": {
+                    "a_key": "", # Properties of the object. Contains field @type with type URL.
+                  },
+                  "serializedObjectValue": {
+                    "objectValue": "A String",
+                  },
+                  "stringArray": {
+                    "stringValues": [
+                      "A String",
+                    ],
+                  },
+                  "stringValue": "A String",
+                },
+              },
+            ],
+          },
+          "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus.
+            "properties": [ # An unordered list of property entries.
+              { # Key-value pair of EventBus property.
+                "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values.
+                "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                  "booleanValue": True or False,
+                  "doubleArray": {
+                    "values": [
+                      3.14,
+                    ],
+                  },
+                  "doubleValue": 3.14,
+                  "intArray": {
+                    "values": [
+                      "A String",
+                    ],
+                  },
+                  "intValue": "A String",
+                  "protoValue": {
+                    "a_key": "", # Properties of the object. Contains field @type with type URL.
+                  },
+                  "stringArray": {
+                    "values": [
+                      "A String",
+                    ],
+                  },
+                  "stringValue": "A String",
+                },
+              },
+            ],
+          },
+          "teardownTaskImplementationClassName": "A String", # Required. Implementation class name.
+        },
+      ],
+    },
+    "triggerConfigs": [ # Optional. Trigger configurations.
+      { # Configuration detail of a trigger.
+        "alertConfig": [ # Optional. An alert threshold configuration for the [trigger + client + integration] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + integration] when published.
+          { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.
+            "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week). For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+            "alertThreshold": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+            "disableAlert": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this integration alert.
+            "displayName": "A String", # Name of the alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the integration.
+            "durationThreshold": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+            "metricType": "A String", # The type of metric.
+            "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+            "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+            "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. # The metric value, above or below which the alert should be triggered.
+              "absolute": "A String", # Absolute value threshold.
+              "percentage": 42, # Percentage threshold.
+            },
+          },
+        ],
+        "cloudSchedulerConfig": { # Cloud Scheduler Trigger configuration # Optional. Cloud Scheduler Trigger related metadata
+          "cronTab": "A String", # Required. The cron tab of cloud scheduler trigger.
+          "errorMessage": "A String", # Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations
+          "location": "A String", # Required. The location where associated cloud scheduler job will be created
+          "serviceAccountEmail": "A String", # Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time
+        },
+        "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+        "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
+        "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger.
+          "names": [ # Optional. List of variable names.
+            "A String",
+          ],
+        },
+        "label": "A String", # Optional. The user created label for a particular trigger.
+        "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed.
+        "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger.
+          "names": [ # Optional. List of variable names.
+            "A String",
+          ],
+        },
+        "position": { # Configuration detail of coordinate, it used for UI # Optional. Informs the front-end application where to draw this error catcher config on the UI.
+          "x": 42, # Required. X axis of the coordinate
+          "y": 42, # Required. Y axis of the coordinate
+        },
+        "properties": { # Optional. Configurable properties of the trigger, not to be confused with integration parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Pub/sub triggers.
+          "a_key": "A String",
+        },
+        "startTasks": [ # Optional. Set of tasks numbers from where the integration execution is started by this trigger. If this is empty, then integration is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same integration execution graph).
+          { # The task that is next in line to be executed, if the condition specified evaluated to true.
+            "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+            "description": "A String", # User-provided description intended to give additional business context about the task.
+            "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+            "taskConfigId": "A String", # ID of the next task.
+            "taskId": "A String", # Task number of the next task.
+          },
+        ],
+        "trigger": "A String", # Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose.
+        "triggerId": "A String", # Optional. Auto-generated trigger ID. The ID is based on the properties that you define in the trigger config. For example, for an API trigger, the trigger ID follows the format: api_trigger/TRIGGER_NAME Where trigger config has properties with value {"Trigger name": TRIGGER_NAME}
+        "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI.
+        "triggerType": "A String", # Optional. Type of trigger
+      },
+    ],
+    "triggerConfigsInternal": [ # Optional. Trigger configurations.
+      { # Configuration detail of a trigger. Next available id: 22
+        "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published.
+          { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.
+            "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+            "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+            "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow.
+            "clientId": "A String", # Client associated with this alert configuration.
+            "durationThresholdMs": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+            "errorEnumList": { # List of error enums for alerts.
+              "enumStrings": [
+                "A String",
+              ],
+              "filterType": "A String",
+            },
+            "metricType": "A String",
+            "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+            "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+            "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+            "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+            "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. # The metric value, above or below which the alert should be triggered.
+              "absolute": "A String",
+              "percentage": 42,
+            },
+            "warningEnumList": { # List of error enums for alerts.
+              "enumStrings": [
+                "A String",
+              ],
+              "filterType": "A String",
+            },
+          },
+        ],
+        "cloudSchedulerConfig": { # Cloud Scheduler Trigger configuration
+          "cronTab": "A String", # Required. The cron tab of cloud scheduler trigger.
+          "errorMessage": "A String", # Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations
+          "location": "A String", # Required. The location where associated cloud scheduler job will be created
+          "serviceAccountEmail": "A String", # Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time
+        },
+        "description": "A String", # User-provided description intended to give more business context about the task.
+        "enabledClients": [ # Required. The list of client ids which are enabled to execute the workflow using this trigger. In other words, these clients have the workflow execution privledges for this trigger. For API trigger, the client id in the incoming request is validated against the list of enabled clients. For non-API triggers, one workflow execution is triggered on behalf of each enabled client.
+          "A String",
+        ],
+        "errorCatcherId": "A String", # Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
+        "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger.
+          "names": [ # Optional. List of variable names.
+            "A String",
+          ],
+        },
+        "label": "A String", # The user created label for a particular trigger.
+        "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed.
+        "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger.
+          "names": [ # Optional. List of variable names.
+            "A String",
+          ],
+        },
+        "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed.
+        "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI.
+          "x": 42,
+          "y": 42,
+        },
+        "properties": { # Configurable properties of the trigger, not to be confused with workflow parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Cloud Pubsub triggers.
+          "a_key": "A String",
+        },
+        "startTasks": [ # Set of tasks numbers from where the workflow execution is started by this trigger. If this is empty, then workflow is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same workflow execution graph).
+          { # The task that is next in line to be executed, if the condition specified evaluated to true.
+            "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+              { # This message recursively combines constituent conditions using logical AND.
+                "conditions": [ # A set of individual constituent conditions.
+                  { # Condition that uses `operator` to evaluate the key against the value.
+                    "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+                    "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+                    "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+                      "booleanValue": True or False,
+                      "doubleArray": {
+                        "values": [
+                          3.14,
+                        ],
+                      },
+                      "doubleValue": 3.14,
+                      "intArray": {
+                        "values": [
+                          "A String",
+                        ],
+                      },
+                      "intValue": "A String",
+                      "protoValue": {
+                        "a_key": "", # Properties of the object. Contains field @type with type URL.
+                      },
+                      "stringArray": {
+                        "values": [
+                          "A String",
+                        ],
+                      },
+                      "stringValue": "A String",
+                    },
+                  },
+                ],
+              },
+            ],
+            "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+            "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+            "label": "A String", # User-provided label that is attached to this edge in the UI.
+            "taskConfigId": "A String", # ID of the next task.
+            "taskNumber": "A String", # Task number of the next task.
+          },
+        ],
+        "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true.
+          "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly.
+          "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Optional. To be used in TaskConfig for the implementation class.
+            "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+              { # Key-value pair of EventBus parameters.
+                "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+                "masked": True or False, # True if this parameter should be masked in the logs
+                "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                  "booleanArray": {
+                    "booleanValues": [
+                      True or False,
+                    ],
+                  },
+                  "booleanValue": True or False,
+                  "doubleArray": {
+                    "doubleValues": [
+                      3.14,
+                    ],
+                  },
+                  "doubleValue": 3.14,
+                  "intArray": {
+                    "intValues": [
+                      "A String",
+                    ],
+                  },
+                  "intValue": "A String",
+                  "protoArray": {
+                    "protoValues": [
+                      {
+                        "a_key": "", # Properties of the object. Contains field @type with type URL.
+                      },
+                    ],
+                  },
+                  "protoValue": {
+                    "a_key": "", # Properties of the object. Contains field @type with type URL.
+                  },
+                  "serializedObjectValue": {
+                    "objectValue": "A String",
+                  },
+                  "stringArray": {
+                    "stringValues": [
+                      "A String",
+                    ],
+                  },
+                  "stringValue": "A String",
+                },
+              },
+            ],
+          },
+          "triggerCriteriaTaskImplementationClassName": "A String", # Optional. Implementation class name. The class should implement the “TypedTask” interface.
+        },
+        "triggerId": "A String", # The backend trigger ID.
+        "triggerName": "A String", # Optional. Name of the trigger This is added to identify the type of trigger. This is avoid the logic on triggerId to identify the trigger_type and push the same to monitoring.
+        "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the workflow on UI.
+        "triggerType": "A String",
+      },
+    ],
+    "updateTime": "A String", # Output only. Auto-generated.
+    "userLabel": "A String", # Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.
+  },
+  "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Optional. Passed in as parameters to each integration execution.
+    "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+      { # Key-value pair of EventBus parameters.
+        "dataType": "A String", # Explicitly getting the type of the parameter.
+        "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+        "masked": True or False, # True if this parameter should be masked in the logs
+        "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+          "booleanArray": {
+            "booleanValues": [
+              True or False,
+            ],
+          },
+          "booleanValue": True or False,
+          "doubleArray": {
+            "doubleValues": [
+              3.14,
+            ],
+          },
+          "doubleValue": 3.14,
+          "intArray": {
+            "intValues": [
+              "A String",
+            ],
+          },
+          "intValue": "A String",
+          "jsonValue": "A String",
+          "protoArray": {
+            "protoValues": [
+              {
+                "a_key": "", # Properties of the object. Contains field @type with type URL.
+              },
+            ],
+          },
+          "protoValue": {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+          "serializedObjectValue": {
+            "objectValue": "A String",
+          },
+          "stringArray": {
+            "stringValues": [
+              "A String",
+            ],
+          },
+          "stringValue": "A String",
+        },
+      },
+    ],
+  },
+  "testMode": True or False, # Optional. Can be specified in the event request, otherwise false (default). If true, enables tasks with condition "test_mode = true". If false, disables tasks with condition "test_mode = true" if global test mode (set by platform) is also false {@link EventBusConfig}.
+  "triggerId": "A String", # Required. The trigger id of the integration trigger config. If both trigger_id and client_id is present, the integration is executed from the start tasks provided by the matching trigger config otherwise it is executed from the default start tasks.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response for testing an integration.
+  "eventParameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see # Details for the integration that were executed.
+    "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+      { # Key-value pair of EventBus parameters.
+        "dataType": "A String", # Explicitly getting the type of the parameter.
+        "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+        "masked": True or False, # True if this parameter should be masked in the logs
+        "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+          "booleanArray": {
+            "booleanValues": [
+              True or False,
+            ],
+          },
+          "booleanValue": True or False,
+          "doubleArray": {
+            "doubleValues": [
+              3.14,
+            ],
+          },
+          "doubleValue": 3.14,
+          "intArray": {
+            "intValues": [
+              "A String",
+            ],
+          },
+          "intValue": "A String",
+          "jsonValue": "A String",
+          "protoArray": {
+            "protoValues": [
+              {
+                "a_key": "", # Properties of the object. Contains field @type with type URL.
+              },
+            ],
+          },
+          "protoValue": {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+          "serializedObjectValue": {
+            "objectValue": "A String",
+          },
+          "stringArray": {
+            "stringValues": [
+              "A String",
+            ],
+          },
+          "stringValue": "A String",
+        },
+      },
+    ],
+  },
+  "executionFailed": True or False, # Is true if any execution in the integration failed. False otherwise.
+  "executionId": "A String", # The id of the execution corresponding to this run of integration.
+  "parameterEntries": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+    { # Key-value pair of EventBus parameters.
+      "dataType": "A String", # Explicitly getting the type of the parameter.
+      "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+      "masked": True or False, # True if this parameter should be masked in the logs
+      "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+        "booleanArray": {
+          "booleanValues": [
+            True or False,
+          ],
+        },
+        "booleanValue": True or False,
+        "doubleArray": {
+          "doubleValues": [
+            3.14,
+          ],
+        },
+        "doubleValue": 3.14,
+        "intArray": {
+          "intValues": [
+            "A String",
+          ],
+        },
+        "intValue": "A String",
+        "jsonValue": "A String",
+        "protoArray": {
+          "protoValues": [
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+        },
+        "protoValue": {
+          "a_key": "", # Properties of the object. Contains field @type with type URL.
+        },
+        "serializedObjectValue": {
+          "objectValue": "A String",
+        },
+        "stringArray": {
+          "stringValues": [
+            "A String",
+          ],
+        },
+        "stringValue": "A String",
+      },
+    },
+  ],
+  "parameters": { # Optional. Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+    "a_key": { # The type of the parameter.
+      "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+        "booleanValues": [ # Boolean array.
+          True or False,
+        ],
+      },
+      "booleanValue": True or False, # Boolean.
+      "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+        "doubleValues": [ # Double number array.
+          3.14,
+        ],
+      },
+      "doubleValue": 3.14, # Double Number.
+      "intArray": { # This message only contains a field of integer array. # Integer Array.
+        "intValues": [ # Integer array.
+          "A String",
+        ],
+      },
+      "intValue": "A String", # Integer.
+      "jsonValue": "A String", # Json.
+      "stringArray": { # This message only contains a field of string array. # String Array.
+        "stringValues": [ # String array.
+          "A String",
+        ],
+      },
+      "stringValue": "A String", # String.
+    },
+  },
+}
+
+
unpublish(name, body=None, x__xgafv=None) 
Sets the status of the ACTIVE integration to SNAPSHOT with a new tag "PREVIOUSLY_PUBLISHED" after validating it. The "HEAD" and "PUBLISH_REQUESTED" tags do not change. This RPC throws an exception if the version being snapshot is not ACTIVE. Audit fields added include action, action_by, action_timestamp.
diff --git a/googleapiclient/discovery_cache/documents/integrations.v1.json b/googleapiclient/discovery_cache/documents/integrations.v1.json
index 3d6a382dcb8..11904358a39 100644
--- a/googleapiclient/discovery_cache/documents/integrations.v1.json
+++ b/googleapiclient/discovery_cache/documents/integrations.v1.json
@@ -2011,6 +2011,34 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
+"test": {
+"description": "Execute the integration in draft state",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:test",
+"httpMethod": "POST",
+"id": "integrations.projects.locations.integrations.versions.test",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Output only. Auto-generated primary key.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}:test",
+"request": {
+"$ref": "GoogleCloudIntegrationsV1alphaTestIntegrationsRequest"
+},
+"response": {
+"$ref": "GoogleCloudIntegrationsV1alphaTestIntegrationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "unpublish": {
 "description": "Sets the status of the ACTIVE integration to SNAPSHOT with a new tag \"PREVIOUSLY_PUBLISHED\" after validating it. The \"HEAD\" and \"PUBLISH_REQUESTED\" tags do not change. This RPC throws an exception if the version being snapshot is not ACTIVE. Audit fields added include action, action_by, action_timestamp.",
 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:unpublish",
@@ -4640,7 +4668,7 @@
 }
 }
 },
-"revision": "20250720",
+"revision": "20250922",
 "rootUrl": "https://integrations.googleapis.com/",
 "schemas": {
 "CrmlogErrorCode": {

From 262129516dfd7cf518e6abbe4050d96ac647bcf3 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 30 Sep 2025 07:09:37 +0000
Subject: [PATCH 26/42] fix(logging): update the api

#### logging:v2

The following keys were changed:
- endpoints (Total Keys: 1)
---
 .../discovery_cache/documents/logging.v2.json   | 17 ++++++++++++++++-
 1 file changed, 16 insertions(+), 1 deletion(-)

diff --git a/googleapiclient/discovery_cache/documents/logging.v2.json b/googleapiclient/discovery_cache/documents/logging.v2.json
index 1ad16a555d0..241cfa5fde9 100644
--- a/googleapiclient/discovery_cache/documents/logging.v2.json
+++ b/googleapiclient/discovery_cache/documents/logging.v2.json
@@ -80,6 +80,11 @@
 },
 {
 "description": "Regional Endpoint",
+"endpointUrl": "https://logging.asia-southeast3.rep.googleapis.com/",
+"location": "asia-southeast3"
+},
+{
+"description": "Regional Endpoint",
 "endpointUrl": "https://logging.australia-southeast1.rep.googleapis.com/",
 "location": "australia-southeast1"
 },
@@ -105,6 +110,11 @@
 },
 {
 "description": "Regional Endpoint",
+"endpointUrl": "https://logging.europe-north3.rep.googleapis.com/",
+"location": "europe-north3"
+},
+{
+"description": "Regional Endpoint",
 "endpointUrl": "https://logging.europe-southwest1.rep.googleapis.com/",
 "location": "europe-southwest1"
 },
@@ -265,6 +275,11 @@
 },
 {
 "description": "Regional Endpoint",
+"endpointUrl": "https://logging.in.rep.googleapis.com/",
+"location": "in"
+},
+{
+"description": "Regional Endpoint",
 "endpointUrl": "https://logging.us.rep.googleapis.com/",
 "location": "us"
 }
@@ -9112,7 +9127,7 @@
 }
 }
 },
-"revision": "20250905",
+"revision": "20250919",
 "rootUrl": "https://logging.googleapis.com/",
 "schemas": {
 "AppHub": {

From fe3809427c52eeac3eb3d33d1ae2f5e76b89826d Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 30 Sep 2025 07:09:37 +0000
Subject: [PATCH 27/42] feat(migrationcenter): update the api

#### migrationcenter: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)
---
 ...ioncenter_v1.projects.locations.operations.html |  8 ++++++--
 .../documents/migrationcenter.v1.json              | 14 +++++++++++++-
 2 files changed, 19 insertions(+), 3 deletions(-)

diff --git a/docs/dyn/migrationcenter_v1.projects.locations.operations.html b/docs/dyn/migrationcenter_v1.projects.locations.operations.html
index b8b23935b40..85a98ee157a 100644
--- a/docs/dyn/migrationcenter_v1.projects.locations.operations.html
+++ b/docs/dyn/migrationcenter_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/migrationcenter.v1.json b/googleapiclient/discovery_cache/documents/migrationcenter.v1.json index 26b2e16328c..2e5685f86a8 100644 --- a/googleapiclient/discovery_cache/documents/migrationcenter.v1.json +++ b/googleapiclient/discovery_cache/documents/migrationcenter.v1.json @@ -1532,6 +1532,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", @@ -2407,7 +2412,7 @@ } } }, -"revision": "20250904", +"revision": "20250928", "rootUrl": "https://migrationcenter.googleapis.com/", "schemas": { "AddAssetsToGroupRequest": { @@ -4766,6 +4771,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 c8f9301d0a116e971fa9e9c79d59f22c285ae0b2 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 30 Sep 2025 07:09:37 +0000 Subject: [PATCH 28/42] feat(oracledatabase): update the api #### oracledatabase:v1 The following keys were added: - resources.projects.resources.locations.resources.autonomousDatabases.methods.patch (Total Keys: 17) - resources.projects.resources.locations.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - schemas.AutonomousDatabaseProperties.properties.encryptionKey (Total Keys: 4) - schemas.AutonomousDatabaseProperties.properties.serviceAgentEmail (Total Keys: 2) - schemas.EncryptionKey (Total Keys: 11) - schemas.ListOperationsResponse.properties.unreachable (Total Keys: 2) --- ...rojects.locations.autonomousDatabases.html | 256 ++++++++++++++++++ ...base_v1.projects.locations.operations.html | 8 +- .../documents/oracledatabase.v1.json | 113 +++++++- 3 files changed, 374 insertions(+), 3 deletions(-) diff --git a/docs/dyn/oracledatabase_v1.projects.locations.autonomousDatabases.html b/docs/dyn/oracledatabase_v1.projects.locations.autonomousDatabases.html index 081fa86ce9f..f1c662244e5 100644 --- a/docs/dyn/oracledatabase_v1.projects.locations.autonomousDatabases.html +++ b/docs/dyn/oracledatabase_v1.projects.locations.autonomousDatabases.html @@ -98,6 +98,9 @@

Instance Methods

list_next()

Retrieves the next page of results.

+

+ patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)

+

Updates the parameters of a single Autonomous Database.

restart(name, body=None, x__xgafv=None)

Restarts an Autonomous Database.

@@ -215,6 +218,19 @@

Method Details

"dbVersion": "A String", # Optional. The Oracle Database version for the Autonomous Database. "dbWorkload": "A String", # Required. The workload type of the Autonomous Database. "disasterRecoveryRoleChangedTime": "A String", # Output only. The date and time the Disaster Recovery role was changed for the standby Autonomous Database. + "encryptionKey": { # The encryption key used to encrypt the Autonomous Database. # Optional. The encryption key used to encrypt the Autonomous Database. Updating this field will add a new entry in the `encryption_key_history_entries` field with the former version. + "kmsKey": "A String", # Optional. The KMS key used to encrypt the Autonomous Database. This field is required if the provider is GOOGLE_MANAGED. The name of the KMS key resource in the following format: `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. + "provider": "A String", # Optional. The provider of the encryption key. + }, + "encryptionKeyHistoryEntries": [ # Output only. The history of the encryption keys used to encrypt the Autonomous Database. + { # The history of the encryption keys used to encrypt the Autonomous Database. + "activationTime": "A String", # Output only. The date and time when the encryption key was activated on the Autonomous Database.. + "encryptionKey": { # The encryption key used to encrypt the Autonomous Database. # Output only. The encryption key used to encrypt the Autonomous Database. + "kmsKey": "A String", # Optional. The KMS key used to encrypt the Autonomous Database. This field is required if the provider is GOOGLE_MANAGED. The name of the KMS key resource in the following format: `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. + "provider": "A String", # Optional. The provider of the encryption key. + }, + }, + ], "failedDataRecoveryDuration": "A String", # Output only. This field indicates the number of seconds of data loss during a Data Guard failover. "isAutoScalingEnabled": True or False, # Optional. This field indicates if auto scaling is enabled for the Autonomous Database CPU core count. "isLocalDataGuardEnabled": True or False, # Output only. This field indicates whether the Autonomous Database has local (in-region) Data Guard enabled. @@ -270,6 +286,7 @@

Method Details

}, ], "secretId": "A String", # Optional. The ID of the Oracle Cloud Infrastructure vault secret. + "serviceAgentEmail": "A String", # Output only. An Oracle-managed Google Cloud service account on which customers can grant roles to access resources in the customer project. "sqlWebDeveloperUrl": "A String", # Output only. The SQL Web Developer URL for the Autonomous Database. "state": "A String", # Output only. The current lifecycle state of the Autonomous Database. "supportedCloneRegions": [ # Output only. The list of available regions that can be used to create a clone for the Autonomous Database. @@ -523,6 +540,19 @@

Method Details

"dbVersion": "A String", # Optional. The Oracle Database version for the Autonomous Database. "dbWorkload": "A String", # Required. The workload type of the Autonomous Database. "disasterRecoveryRoleChangedTime": "A String", # Output only. The date and time the Disaster Recovery role was changed for the standby Autonomous Database. + "encryptionKey": { # The encryption key used to encrypt the Autonomous Database. # Optional. The encryption key used to encrypt the Autonomous Database. Updating this field will add a new entry in the `encryption_key_history_entries` field with the former version. + "kmsKey": "A String", # Optional. The KMS key used to encrypt the Autonomous Database. This field is required if the provider is GOOGLE_MANAGED. The name of the KMS key resource in the following format: `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. + "provider": "A String", # Optional. The provider of the encryption key. + }, + "encryptionKeyHistoryEntries": [ # Output only. The history of the encryption keys used to encrypt the Autonomous Database. + { # The history of the encryption keys used to encrypt the Autonomous Database. + "activationTime": "A String", # Output only. The date and time when the encryption key was activated on the Autonomous Database.. + "encryptionKey": { # The encryption key used to encrypt the Autonomous Database. # Output only. The encryption key used to encrypt the Autonomous Database. + "kmsKey": "A String", # Optional. The KMS key used to encrypt the Autonomous Database. This field is required if the provider is GOOGLE_MANAGED. The name of the KMS key resource in the following format: `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. + "provider": "A String", # Optional. The provider of the encryption key. + }, + }, + ], "failedDataRecoveryDuration": "A String", # Output only. This field indicates the number of seconds of data loss during a Data Guard failover. "isAutoScalingEnabled": True or False, # Optional. This field indicates if auto scaling is enabled for the Autonomous Database CPU core count. "isLocalDataGuardEnabled": True or False, # Output only. This field indicates whether the Autonomous Database has local (in-region) Data Guard enabled. @@ -578,6 +608,7 @@

Method Details

}, ], "secretId": "A String", # Optional. The ID of the Oracle Cloud Infrastructure vault secret. + "serviceAgentEmail": "A String", # Output only. An Oracle-managed Google Cloud service account on which customers can grant roles to access resources in the customer project. "sqlWebDeveloperUrl": "A String", # Output only. The SQL Web Developer URL for the Autonomous Database. "state": "A String", # Output only. The current lifecycle state of the Autonomous Database. "supportedCloneRegions": [ # Output only. The list of available regions that can be used to create a clone for the Autonomous Database. @@ -701,6 +732,19 @@

Method Details

"dbVersion": "A String", # Optional. The Oracle Database version for the Autonomous Database. "dbWorkload": "A String", # Required. The workload type of the Autonomous Database. "disasterRecoveryRoleChangedTime": "A String", # Output only. The date and time the Disaster Recovery role was changed for the standby Autonomous Database. + "encryptionKey": { # The encryption key used to encrypt the Autonomous Database. # Optional. The encryption key used to encrypt the Autonomous Database. Updating this field will add a new entry in the `encryption_key_history_entries` field with the former version. + "kmsKey": "A String", # Optional. The KMS key used to encrypt the Autonomous Database. This field is required if the provider is GOOGLE_MANAGED. The name of the KMS key resource in the following format: `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. + "provider": "A String", # Optional. The provider of the encryption key. + }, + "encryptionKeyHistoryEntries": [ # Output only. The history of the encryption keys used to encrypt the Autonomous Database. + { # The history of the encryption keys used to encrypt the Autonomous Database. + "activationTime": "A String", # Output only. The date and time when the encryption key was activated on the Autonomous Database.. + "encryptionKey": { # The encryption key used to encrypt the Autonomous Database. # Output only. The encryption key used to encrypt the Autonomous Database. + "kmsKey": "A String", # Optional. The KMS key used to encrypt the Autonomous Database. This field is required if the provider is GOOGLE_MANAGED. The name of the KMS key resource in the following format: `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. + "provider": "A String", # Optional. The provider of the encryption key. + }, + }, + ], "failedDataRecoveryDuration": "A String", # Output only. This field indicates the number of seconds of data loss during a Data Guard failover. "isAutoScalingEnabled": True or False, # Optional. This field indicates if auto scaling is enabled for the Autonomous Database CPU core count. "isLocalDataGuardEnabled": True or False, # Output only. This field indicates whether the Autonomous Database has local (in-region) Data Guard enabled. @@ -756,6 +800,7 @@

Method Details

}, ], "secretId": "A String", # Optional. The ID of the Oracle Cloud Infrastructure vault secret. + "serviceAgentEmail": "A String", # Output only. An Oracle-managed Google Cloud service account on which customers can grant roles to access resources in the customer project. "sqlWebDeveloperUrl": "A String", # Output only. The SQL Web Developer URL for the Autonomous Database. "state": "A String", # Output only. The current lifecycle state of the Autonomous Database. "supportedCloneRegions": [ # Output only. The list of available regions that can be used to create a clone for the Autonomous Database. @@ -789,6 +834,217 @@

Method Details

+
+ patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None) + 
Updates the parameters of a single Autonomous Database.
+
+Args:
+  name: string, Identifier. The name of the Autonomous Database resource in the following format: projects/{project}/locations/{region}/autonomousDatabases/{autonomous_database} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Details of the Autonomous Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabase/
+  "adminPassword": "A String", # Optional. The password for the default ADMIN user.
+  "cidr": "A String", # Optional. The subnet CIDR range for the Autonomous Database.
+  "createTime": "A String", # Output only. The date and time that the Autonomous Database was created.
+  "database": "A String", # Optional. The name of the Autonomous Database. The database name must be unique in the project. The name must begin with a letter and can contain a maximum of 30 alphanumeric characters.
+  "disasterRecoverySupportedLocations": [ # Output only. List of supported GCP region to clone the Autonomous Database for disaster recovery. Format: `project/{project}/locations/{location}`.
+    "A String",
+  ],
+  "displayName": "A String", # Optional. The display name for the Autonomous Database. The name does not have to be unique within your project.
+  "entitlementId": "A String", # Output only. The ID of the subscription entitlement associated with the Autonomous Database.
+  "labels": { # Optional. The labels or tags associated with the Autonomous Database.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The name of the Autonomous Database resource in the following format: projects/{project}/locations/{region}/autonomousDatabases/{autonomous_database}
+  "network": "A String", # Optional. The name of the VPC network used by the Autonomous Database in the following format: projects/{project}/global/networks/{network}
+  "odbNetwork": "A String", # Optional. The name of the OdbNetwork associated with the Autonomous Database. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the OdbSubnet.
+  "odbSubnet": "A String", # Optional. The name of the OdbSubnet associated with the Autonomous Database. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}
+  "peerAutonomousDatabases": [ # Output only. The peer Autonomous Database names of the given Autonomous Database.
+    "A String",
+  ],
+  "properties": { # The properties of an Autonomous Database. # Optional. The properties of the Autonomous Database.
+    "actualUsedDataStorageSizeTb": 3.14, # Output only. The amount of storage currently being used for user and system data, in terabytes.
+    "allocatedStorageSizeTb": 3.14, # Output only. The amount of storage currently allocated for the database tables and billed for, rounded up in terabytes.
+    "allowlistedIps": [ # Optional. The list of allowlisted IP addresses for the Autonomous Database.
+      "A String",
+    ],
+    "apexDetails": { # Oracle APEX Application Development. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseApex # Output only. The details for the Oracle APEX Application Development.
+      "apexVersion": "A String", # Output only. The Oracle APEX Application Development version.
+      "ordsVersion": "A String", # Output only. The Oracle REST Data Services (ORDS) version.
+    },
+    "arePrimaryAllowlistedIpsUsed": True or False, # Output only. This field indicates the status of Data Guard and Access control for the Autonomous Database. The field's value is null if Data Guard is disabled or Access Control is disabled. The field's value is TRUE if both Data Guard and Access Control are enabled, and the Autonomous Database is using primary IP access control list (ACL) for standby. The field's value is FALSE if both Data Guard and Access Control are enabled, and the Autonomous Database is using a different IP access control list (ACL) for standby compared to primary.
+    "autonomousContainerDatabaseId": "A String", # Output only. The Autonomous Container Database OCID.
+    "availableUpgradeVersions": [ # Output only. The list of available Oracle Database upgrade versions for an Autonomous Database.
+      "A String",
+    ],
+    "backupRetentionPeriodDays": 42, # Optional. The retention period for the Autonomous Database. This field is specified in days, can range from 1 day to 60 days, and has a default value of 60 days.
+    "characterSet": "A String", # Optional. The character set for the Autonomous Database. The default is AL32UTF8.
+    "computeCount": 3.14, # Optional. The number of compute servers for the Autonomous Database.
+    "connectionStrings": { # The connection string used to connect to the Autonomous Database. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseConnectionStrings # Output only. The connection strings used to connect to an Autonomous Database.
+      "allConnectionStrings": { # A list of all connection strings that can be used to connect to the Autonomous Database. # Output only. Returns all connection strings that can be used to connect to the Autonomous Database.
+        "high": "A String", # Output only. The database service provides the highest level of resources to each SQL statement.
+        "low": "A String", # Output only. The database service provides the least level of resources to each SQL statement.
+        "medium": "A String", # Output only. The database service provides a lower level of resources to each SQL statement.
+      },
+      "dedicated": "A String", # Output only. The database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements.
+      "high": "A String", # Output only. The database service provides the highest level of resources to each SQL statement.
+      "low": "A String", # Output only. The database service provides the least level of resources to each SQL statement.
+      "medium": "A String", # Output only. The database service provides a lower level of resources to each SQL statement.
+      "profiles": [ # Output only. A list of connection string profiles to allow clients to group, filter, and select values based on the structured metadata.
+        { # The connection string profile to allow clients to group. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/DatabaseConnectionStringProfile
+          "consumerGroup": "A String", # Output only. The current consumer group being used by the connection.
+          "displayName": "A String", # Output only. The display name for the database connection.
+          "hostFormat": "A String", # Output only. The host name format being currently used in connection string.
+          "isRegional": True or False, # Output only. This field indicates if the connection string is regional and is only applicable for cross-region Data Guard.
+          "protocol": "A String", # Output only. The protocol being used by the connection.
+          "sessionMode": "A String", # Output only. The current session mode of the connection.
+          "syntaxFormat": "A String", # Output only. The syntax of the connection string.
+          "tlsAuthentication": "A String", # Output only. This field indicates the TLS authentication type of the connection.
+          "value": "A String", # Output only. The value of the connection string.
+        },
+      ],
+    },
+    "connectionUrls": { # The URLs for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseConnectionUrls # Output only. The Oracle Connection URLs for an Autonomous Database.
+      "apexUri": "A String", # Output only. Oracle Application Express (APEX) URL.
+      "databaseTransformsUri": "A String", # Output only. The URL of the Database Transforms for the Autonomous Database.
+      "graphStudioUri": "A String", # Output only. The URL of the Graph Studio for the Autonomous Database.
+      "machineLearningNotebookUri": "A String", # Output only. The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous Database.
+      "machineLearningUserManagementUri": "A String", # Output only. The URL of Machine Learning user management the Autonomous Database.
+      "mongoDbUri": "A String", # Output only. The URL of the MongoDB API for the Autonomous Database.
+      "ordsUri": "A String", # Output only. The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous Database.
+      "sqlDevWebUri": "A String", # Output only. The URL of the Oracle SQL Developer Web for the Autonomous Database.
+    },
+    "cpuCoreCount": 42, # Optional. The number of CPU cores to be made available to the database.
+    "customerContacts": [ # Optional. The list of customer contacts.
+      { # The CustomerContact reference as defined by Oracle. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/CustomerContact
+        "email": "A String", # Required. The email address used by Oracle to send notifications regarding databases and infrastructure.
+      },
+    ],
+    "dataGuardRoleChangedTime": "A String", # Output only. The date and time the Autonomous Data Guard role was changed for the standby Autonomous Database.
+    "dataSafeState": "A String", # Output only. The current state of the Data Safe registration for the Autonomous Database.
+    "dataStorageSizeGb": 42, # Optional. The size of the data stored in the database, in gigabytes.
+    "dataStorageSizeTb": 42, # Optional. The size of the data stored in the database, in terabytes.
+    "databaseManagementState": "A String", # Output only. The current state of database management for the Autonomous Database.
+    "dbEdition": "A String", # Optional. The edition of the Autonomous Databases.
+    "dbVersion": "A String", # Optional. The Oracle Database version for the Autonomous Database.
+    "dbWorkload": "A String", # Required. The workload type of the Autonomous Database.
+    "disasterRecoveryRoleChangedTime": "A String", # Output only. The date and time the Disaster Recovery role was changed for the standby Autonomous Database.
+    "encryptionKey": { # The encryption key used to encrypt the Autonomous Database. # Optional. The encryption key used to encrypt the Autonomous Database. Updating this field will add a new entry in the `encryption_key_history_entries` field with the former version.
+      "kmsKey": "A String", # Optional. The KMS key used to encrypt the Autonomous Database. This field is required if the provider is GOOGLE_MANAGED. The name of the KMS key resource in the following format: `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
+      "provider": "A String", # Optional. The provider of the encryption key.
+    },
+    "encryptionKeyHistoryEntries": [ # Output only. The history of the encryption keys used to encrypt the Autonomous Database.
+      { # The history of the encryption keys used to encrypt the Autonomous Database.
+        "activationTime": "A String", # Output only. The date and time when the encryption key was activated on the Autonomous Database..
+        "encryptionKey": { # The encryption key used to encrypt the Autonomous Database. # Output only. The encryption key used to encrypt the Autonomous Database.
+          "kmsKey": "A String", # Optional. The KMS key used to encrypt the Autonomous Database. This field is required if the provider is GOOGLE_MANAGED. The name of the KMS key resource in the following format: `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
+          "provider": "A String", # Optional. The provider of the encryption key.
+        },
+      },
+    ],
+    "failedDataRecoveryDuration": "A String", # Output only. This field indicates the number of seconds of data loss during a Data Guard failover.
+    "isAutoScalingEnabled": True or False, # Optional. This field indicates if auto scaling is enabled for the Autonomous Database CPU core count.
+    "isLocalDataGuardEnabled": True or False, # Output only. This field indicates whether the Autonomous Database has local (in-region) Data Guard enabled.
+    "isStorageAutoScalingEnabled": True or False, # Optional. This field indicates if auto scaling is enabled for the Autonomous Database storage.
+    "licenseType": "A String", # Required. The license type used for the Autonomous Database.
+    "lifecycleDetails": "A String", # Output only. The details of the current lifestyle state of the Autonomous Database.
+    "localAdgAutoFailoverMaxDataLossLimit": 42, # Output only. This field indicates the maximum data loss limit for an Autonomous Database, in seconds.
+    "localDisasterRecoveryType": "A String", # Output only. This field indicates the local disaster recovery (DR) type of an Autonomous Database.
+    "localStandbyDb": { # Autonomous Data Guard standby database details. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseStandbySummary # Output only. The details of the Autonomous Data Guard standby database.
+      "dataGuardRoleChangedTime": "A String", # Output only. The date and time the Autonomous Data Guard role was switched for the standby Autonomous Database.
+      "disasterRecoveryRoleChangedTime": "A String", # Output only. The date and time the Disaster Recovery role was switched for the standby Autonomous Database.
+      "lagTimeDuration": "A String", # Output only. The amount of time, in seconds, that the data of the standby database lags in comparison to the data of the primary database.
+      "lifecycleDetails": "A String", # Output only. The additional details about the current lifecycle state of the Autonomous Database.
+      "state": "A String", # Output only. The current lifecycle state of the Autonomous Database.
+    },
+    "maintenanceBeginTime": "A String", # Output only. The date and time when maintenance will begin.
+    "maintenanceEndTime": "A String", # Output only. The date and time when maintenance will end.
+    "maintenanceScheduleType": "A String", # Optional. The maintenance schedule of the Autonomous Database.
+    "memoryPerOracleComputeUnitGbs": 42, # Output only. The amount of memory enabled per ECPU, in gigabytes.
+    "memoryTableGbs": 42, # Output only. The memory assigned to in-memory tables in an Autonomous Database.
+    "mtlsConnectionRequired": True or False, # Optional. This field specifies if the Autonomous Database requires mTLS connections.
+    "nCharacterSet": "A String", # Optional. The national character set for the Autonomous Database. The default is AL16UTF16.
+    "nextLongTermBackupTime": "A String", # Output only. The long term backup schedule of the Autonomous Database.
+    "ociUrl": "A String", # Output only. The Oracle Cloud Infrastructure link for the Autonomous Database.
+    "ocid": "A String", # Output only. OCID of the Autonomous Database. https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle
+    "openMode": "A String", # Output only. This field indicates the current mode of the Autonomous Database.
+    "operationsInsightsState": "A String", # Output only. This field indicates the state of Operations Insights for the Autonomous Database.
+    "peerDbIds": [ # Output only. The list of OCIDs of standby databases located in Autonomous Data Guard remote regions that are associated with the source database.
+      "A String",
+    ],
+    "permissionLevel": "A String", # Output only. The permission level of the Autonomous Database.
+    "privateEndpoint": "A String", # Output only. The private endpoint for the Autonomous Database.
+    "privateEndpointIp": "A String", # Optional. The private endpoint IP address for the Autonomous Database.
+    "privateEndpointLabel": "A String", # Optional. The private endpoint label for the Autonomous Database.
+    "refreshableMode": "A String", # Output only. The refresh mode of the cloned Autonomous Database.
+    "refreshableState": "A String", # Output only. The refresh State of the clone.
+    "role": "A String", # Output only. The Data Guard role of the Autonomous Database.
+    "scheduledOperationDetails": [ # Output only. The list and details of the scheduled operations of the Autonomous Database.
+      { # Details of scheduled operation. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/ScheduledOperationDetails
+        "dayOfWeek": "A String", # Output only. Day of week.
+        "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`. # Output only. Auto start time.
+          "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.
+        },
+        "stopTime": { # 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`. # Output only. Auto stop time.
+          "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.
+        },
+      },
+    ],
+    "secretId": "A String", # Optional. The ID of the Oracle Cloud Infrastructure vault secret.
+    "serviceAgentEmail": "A String", # Output only. An Oracle-managed Google Cloud service account on which customers can grant roles to access resources in the customer project.
+    "sqlWebDeveloperUrl": "A String", # Output only. The SQL Web Developer URL for the Autonomous Database.
+    "state": "A String", # Output only. The current lifecycle state of the Autonomous Database.
+    "supportedCloneRegions": [ # Output only. The list of available regions that can be used to create a clone for the Autonomous Database.
+      "A String",
+    ],
+    "totalAutoBackupStorageSizeGbs": 3.14, # Output only. The storage space used by automatic backups of Autonomous Database, in gigabytes.
+    "usedDataStorageSizeTbs": 42, # Output only. The storage space used by Autonomous Database, in gigabytes.
+    "vaultId": "A String", # Optional. The ID of the Oracle Cloud Infrastructure vault.
+  },
+  "sourceConfig": { # The source configuration for the standby Autonomous Database. # Optional. The source Autonomous Database configuration for the standby Autonomous Database. The source Autonomous Database is configured while creating the Peer Autonomous Database and can't be updated after creation.
+    "automaticBackupsReplicationEnabled": True or False, # Optional. This field specifies if the replication of automatic backups is enabled when creating a Data Guard.
+    "autonomousDatabase": "A String", # Optional. The name of the primary Autonomous Database that is used to create a Peer Autonomous Database from a source.
+  },
+}
+
+  requestId: string, Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, 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. Field mask is used to specify the fields to be overwritten in the Exadata resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
+  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.
+  },
+}
+
+
restart(name, body=None, x__xgafv=None) 
Restarts an Autonomous Database.
diff --git a/docs/dyn/oracledatabase_v1.projects.locations.operations.html b/docs/dyn/oracledatabase_v1.projects.locations.operations.html
index b09d9244c81..1d1181329e1 100644
--- a/docs/dyn/oracledatabase_v1.projects.locations.operations.html
+++ b/docs/dyn/oracledatabase_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/oracledatabase.v1.json b/googleapiclient/discovery_cache/documents/oracledatabase.v1.json index 1a7b928f3e7..229af237ffe 100644 --- a/googleapiclient/discovery_cache/documents/oracledatabase.v1.json +++ b/googleapiclient/discovery_cache/documents/oracledatabase.v1.json @@ -470,6 +470,45 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"patch": { +"description": "Updates the parameters of a single Autonomous Database.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabases/{autonomousDatabasesId}", +"httpMethod": "PATCH", +"id": "oracledatabase.projects.locations.autonomousDatabases.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The name of the Autonomous Database resource in the following format: projects/{project}/locations/{region}/autonomousDatabases/{autonomous_database}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/autonomousDatabases/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, 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. Field mask is used to specify the fields to be overwritten in the Exadata resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "AutonomousDatabase" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "restart": { "description": "Restarts an Autonomous Database.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabases/{autonomousDatabasesId}:restart", @@ -2299,6 +2338,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", @@ -2386,7 +2430,7 @@ } } }, -"revision": "20250918", +"revision": "20250925", "rootUrl": "https://oracledatabase.googleapis.com/", "schemas": { "AllConnectionStrings": { @@ -2978,6 +3022,18 @@ "readOnly": true, "type": "string" }, +"encryptionKey": { +"$ref": "EncryptionKey", +"description": "Optional. The encryption key used to encrypt the Autonomous Database. Updating this field will add a new entry in the `encryption_key_history_entries` field with the former version." +}, +"encryptionKeyHistoryEntries": { +"description": "Output only. The history of the encryption keys used to encrypt the Autonomous Database.", +"items": { +"$ref": "EncryptionKeyHistoryEntry" +}, +"readOnly": true, +"type": "array" +}, "failedDataRecoveryDuration": { "description": "Output only. This field indicates the number of seconds of data loss during a Data Guard failover.", "format": "google-duration", @@ -3241,6 +3297,11 @@ "description": "Optional. The ID of the Oracle Cloud Infrastructure vault secret.", "type": "string" }, +"serviceAgentEmail": { +"description": "Output only. An Oracle-managed Google Cloud service account on which customers can grant roles to access resources in the customer project.", +"readOnly": true, +"type": "string" +}, "sqlWebDeveloperUrl": { "description": "Output only. The SQL Web Developer URL for the Autonomous Database.", "readOnly": true, @@ -5218,6 +5279,49 @@ "properties": {}, "type": "object" }, +"EncryptionKey": { +"description": "The encryption key used to encrypt the Autonomous Database.", +"id": "EncryptionKey", +"properties": { +"kmsKey": { +"description": "Optional. The KMS key used to encrypt the Autonomous Database. This field is required if the provider is GOOGLE_MANAGED. The name of the KMS key resource in the following format: `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.", +"type": "string" +}, +"provider": { +"description": "Optional. The provider of the encryption key.", +"enum": [ +"PROVIDER_UNSPECIFIED", +"GOOGLE_MANAGED", +"ORACLE_MANAGED" +], +"enumDescriptions": [ +"Default unspecified value.", +"Google Managed KMS key, if selected, please provide the KMS key name.", +"Oracle Managed." +], +"type": "string" +} +}, +"type": "object" +}, +"EncryptionKeyHistoryEntry": { +"description": "The history of the encryption keys used to encrypt the Autonomous Database.", +"id": "EncryptionKeyHistoryEntry", +"properties": { +"activationTime": { +"description": "Output only. The date and time when the encryption key was activated on the Autonomous Database..", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"encryptionKey": { +"$ref": "EncryptionKey", +"description": "Output only. The encryption key used to encrypt the Autonomous Database.", +"readOnly": true +} +}, +"type": "object" +}, "Entitlement": { "description": "Details of the Entitlement resource.", "id": "Entitlement", @@ -6151,6 +6255,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 e7ad756e90e296018335bab4ed630023e2da3b4f Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 30 Sep 2025 07:09:37 +0000 Subject: [PATCH 29/42] feat(oslogin): update the api #### oslogin:v1 The following keys were added: - resources.projects.resources.locations.methods.signSshPublicKey (Total Keys: 12) - schemas.SignSshPublicKeyRequest (Total Keys: 6) - schemas.SignSshPublicKeyResponse (Total Keys: 3) --- docs/dyn/oslogin_v1.html | 5 + docs/dyn/oslogin_v1.projects.html | 91 ++++++++++++++ docs/dyn/oslogin_v1.projects.locations.html | 118 ++++++++++++++++++ .../discovery_cache/documents/oslogin.v1.json | 72 ++++++++++- 4 files changed, 285 insertions(+), 1 deletion(-) create mode 100644 docs/dyn/oslogin_v1.projects.html create mode 100644 docs/dyn/oslogin_v1.projects.locations.html diff --git a/docs/dyn/oslogin_v1.html b/docs/dyn/oslogin_v1.html index c375cfb34b4..c11e31a4425 100644 --- a/docs/dyn/oslogin_v1.html +++ b/docs/dyn/oslogin_v1.html @@ -74,6 +74,11 @@

Cloud OS Login API

Instance Methods

+

+ projects() +

+

Returns the projects Resource.

+

users()

diff --git a/docs/dyn/oslogin_v1.projects.html b/docs/dyn/oslogin_v1.projects.html new file mode 100644 index 00000000000..ba2874b99df --- /dev/null +++ b/docs/dyn/oslogin_v1.projects.html @@ -0,0 +1,91 @@ + + + +

Cloud OS Login API . projects

+

Instance Methods

+

+ locations() +

+

Returns the locations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/oslogin_v1.projects.locations.html b/docs/dyn/oslogin_v1.projects.locations.html new file mode 100644 index 00000000000..42936d28ba2 --- /dev/null +++ b/docs/dyn/oslogin_v1.projects.locations.html @@ -0,0 +1,118 @@ + + + +

Cloud OS Login API . projects . locations

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ signSshPublicKey(parent, body=None, x__xgafv=None)

+

Signs an SSH public key for a user to authenticate to a virtual machine on Google Compute Engine.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ signSshPublicKey(parent, body=None, x__xgafv=None) + 
Signs an SSH public key for a user to authenticate to a virtual machine on Google Compute Engine.
+
+Args:
+  parent: string, Required. The parent for the signing request. Format: projects/{project}/locations/{location} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A request message for signing an SSH public key.
+  "appEngineInstance": "A String", # The App Engine instance to sign the SSH public key for. Expected format: apps/{app}/services/{service}/versions/{version}/instances/{instance}
+  "computeInstance": "A String", # The Compute instance to sign the SSH public key for. Expected format: projects/{project}/zones/{zone}/instances/{numeric_instance_id}
+  "serviceAccount": "A String", # Optional. The service account for the instance. If the instance in question does not have a service account, this field should be left empty. If the wrong service account is provided, this operation will return a signed certificate that will not be accepted by the VM.
+  "sshPublicKey": "A String", # Required. The SSH public key to sign.
+}
+
+  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 signing an SSH public key.
+  "signedSshPublicKey": "A String", # The signed SSH public key to use in the SSH handshake.
+}
+
+ + \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/oslogin.v1.json b/googleapiclient/discovery_cache/documents/oslogin.v1.json index fabef34b36c..05de8f4303f 100644 --- a/googleapiclient/discovery_cache/documents/oslogin.v1.json +++ b/googleapiclient/discovery_cache/documents/oslogin.v1.json @@ -114,6 +114,42 @@ }, "protocol": "rest", "resources": { +"projects": { +"resources": { +"locations": { +"methods": { +"signSshPublicKey": { +"description": "Signs an SSH public key for a user to authenticate to a virtual machine on Google Compute Engine.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}:signSshPublicKey", +"httpMethod": "POST", +"id": "oslogin.projects.locations.signSshPublicKey", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent for the signing request. Format: projects/{project}/locations/{location}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}:signSshPublicKey", +"request": { +"$ref": "SignSshPublicKeyRequest" +}, +"response": { +"$ref": "SignSshPublicKeyResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, "users": { "methods": { "getLoginProfile": { @@ -349,7 +385,7 @@ } } }, -"revision": "20250518", +"revision": "20250921", "rootUrl": "https://oslogin.googleapis.com/", "schemas": { "Empty": { @@ -463,6 +499,40 @@ }, "type": "object" }, +"SignSshPublicKeyRequest": { +"description": "A request message for signing an SSH public key.", +"id": "SignSshPublicKeyRequest", +"properties": { +"appEngineInstance": { +"description": "The App Engine instance to sign the SSH public key for. Expected format: apps/{app}/services/{service}/versions/{version}/instances/{instance}", +"type": "string" +}, +"computeInstance": { +"description": "The Compute instance to sign the SSH public key for. Expected format: projects/{project}/zones/{zone}/instances/{numeric_instance_id}", +"type": "string" +}, +"serviceAccount": { +"description": "Optional. The service account for the instance. If the instance in question does not have a service account, this field should be left empty. If the wrong service account is provided, this operation will return a signed certificate that will not be accepted by the VM.", +"type": "string" +}, +"sshPublicKey": { +"description": "Required. The SSH public key to sign.", +"type": "string" +} +}, +"type": "object" +}, +"SignSshPublicKeyResponse": { +"description": "The response message for signing an SSH public key.", +"id": "SignSshPublicKeyResponse", +"properties": { +"signedSshPublicKey": { +"description": "The signed SSH public key to use in the SSH handshake.", +"type": "string" +} +}, +"type": "object" +}, "SshPublicKey": { "description": "The SSH public key information associated with a Google account.", "id": "SshPublicKey", From 2d0c402dfb89d8087023531ca2e728b85a9f3a0e Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 30 Sep 2025 07:09:37 +0000 Subject: [PATCH 30/42] fix(parametermanager): update the api #### parametermanager:v1 The following keys were changed: - endpoints (Total Keys: 1) --- .../documents/parametermanager.v1.json | 92 ++++++++++++++++++- 1 file changed, 91 insertions(+), 1 deletion(-) diff --git a/googleapiclient/discovery_cache/documents/parametermanager.v1.json b/googleapiclient/discovery_cache/documents/parametermanager.v1.json index 5617d8ce0d5..f075f12a555 100644 --- a/googleapiclient/discovery_cache/documents/parametermanager.v1.json +++ b/googleapiclient/discovery_cache/documents/parametermanager.v1.json @@ -140,6 +140,96 @@ "description": "Regional Endpoint", "endpointUrl": "https://parametermanager.northamerica-northeast2.rep.googleapis.com/", "location": "northamerica-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://parametermanager.europe-west12.rep.googleapis.com/", +"location": "europe-west12" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://parametermanager.africa-south1.rep.googleapis.com/", +"location": "africa-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://parametermanager.asia-southeast1.rep.googleapis.com/", +"location": "asia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://parametermanager.asia-southeast2.rep.googleapis.com/", +"location": "asia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://parametermanager.me-central1.rep.googleapis.com/", +"location": "me-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://parametermanager.southamerica-east1.rep.googleapis.com/", +"location": "southamerica-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://parametermanager.asia-south1.rep.googleapis.com/", +"location": "asia-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://parametermanager.europe-west10.rep.googleapis.com/", +"location": "europe-west10" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://parametermanager.europe-north1.rep.googleapis.com/", +"location": "europe-north1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://parametermanager.europe-central2.rep.googleapis.com/", +"location": "europe-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://parametermanager.europe-southwest1.rep.googleapis.com/", +"location": "europe-southwest1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://parametermanager.asia-south2.rep.googleapis.com/", +"location": "asia-south2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://parametermanager.asia-east1.rep.googleapis.com/", +"location": "asia-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://parametermanager.asia-east2.rep.googleapis.com/", +"location": "asia-east2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://parametermanager.asia-northeast2.rep.googleapis.com/", +"location": "asia-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://parametermanager.asia-northeast3.rep.googleapis.com/", +"location": "asia-northeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://parametermanager.northamerica-south1.rep.googleapis.com/", +"location": "northamerica-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://parametermanager.southamerica-west1.rep.googleapis.com/", +"location": "southamerica-west1" } ], "fullyEncodeReservedExpansion": true, @@ -721,7 +811,7 @@ } } }, -"revision": "20250910", +"revision": "20250917", "rootUrl": "https://parametermanager.googleapis.com/", "schemas": { "Empty": { From 5f5b8563e930c85669417d9378687a189081ee67 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 30 Sep 2025 07:09:37 +0000 Subject: [PATCH 31/42] feat(places): update the api #### places:v1 The following keys were added: - schemas.GoogleMapsPlacesV1Place.properties.consumerAlert.$ref (Total Keys: 1) - schemas.GoogleMapsPlacesV1PlaceConsumerAlert (Total Keys: 11) - schemas.GoogleMapsPlacesV1Review.properties.visitDate.$ref (Total Keys: 1) --- docs/dyn/places_v1.places.html | 61 ++++++++++++++++++ .../discovery_cache/documents/places.v1.json | 63 ++++++++++++++++++- 2 files changed, 123 insertions(+), 1 deletion(-) diff --git a/docs/dyn/places_v1.places.html b/docs/dyn/places_v1.places.html index 36c16bb1e4a..07dc74478ae 100644 --- a/docs/dyn/places_v1.places.html +++ b/docs/dyn/places_v1.places.html @@ -325,6 +325,18 @@

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.ƒ + "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. + }, + "description": "A String", # The description of the consumer alert message. + "title": "A String", # The title to show together with the description. + }, + "languageCode": "A String", # The language code of the consumer alert message. This is a BCP 47 language code. + "overview": "A String", # The overview of the consumer alert message. + }, "containingPlaces": [ # List of places in which the current place is located. { # Info about the place in which this place is located. "id": "A String", # The place id of the place in which this place is located. @@ -759,6 +771,11 @@

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. + "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. + }, }, ], "servesBeer": True or False, # Specifies if the place serves beer. @@ -917,6 +934,18 @@

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.ƒ + "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. + }, + "description": "A String", # The description of the consumer alert message. + "title": "A String", # The title to show together with the description. + }, + "languageCode": "A String", # The language code of the consumer alert message. This is a BCP 47 language code. + "overview": "A String", # The overview of the consumer alert message. + }, "containingPlaces": [ # List of places in which the current place is located. { # Info about the place in which this place is located. "id": "A String", # The place id of the place in which this place is located. @@ -1351,6 +1380,11 @@

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. + "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. + }, }, ], "servesBeer": True or False, # Specifies if the place serves beer. @@ -1537,6 +1571,11 @@

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. + "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. + }, }, }, }, @@ -1578,6 +1617,11 @@

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. + "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. + }, }, ], }, @@ -1639,6 +1683,18 @@

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.ƒ + "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. + }, + "description": "A String", # The description of the consumer alert message. + "title": "A String", # The title to show together with the description. + }, + "languageCode": "A String", # The language code of the consumer alert message. This is a BCP 47 language code. + "overview": "A String", # The overview of the consumer alert message. + }, "containingPlaces": [ # List of places in which the current place is located. { # Info about the place in which this place is located. "id": "A String", # The place id of the place in which this place is located. @@ -2073,6 +2129,11 @@

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. + "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. + }, }, ], "servesBeer": True or False, # Specifies if the place serves beer. diff --git a/googleapiclient/discovery_cache/documents/places.v1.json b/googleapiclient/discovery_cache/documents/places.v1.json index 83470bc2849..1396dae5b4e 100644 --- a/googleapiclient/discovery_cache/documents/places.v1.json +++ b/googleapiclient/discovery_cache/documents/places.v1.json @@ -280,7 +280,7 @@ } } }, -"revision": "20250810", +"revision": "20250921", "rootUrl": "https://places.googleapis.com/", "schemas": { "GoogleGeoTypeViewport": { @@ -1056,6 +1056,10 @@ ], "type": "string" }, +"consumerAlert": { +"$ref": "GoogleMapsPlacesV1PlaceConsumerAlert", +"description": "The consumer alert message for the place when we detect suspicious review activity on a business or a business violates our policies." +}, "containingPlaces": { "description": "List of places in which the current place is located.", "items": { @@ -1423,6 +1427,59 @@ }, "type": "object" }, +"GoogleMapsPlacesV1PlaceConsumerAlert": { +"description": "The consumer alert message for the place when we detect suspicious review activity on a business or a business violates our policies.", +"id": "GoogleMapsPlacesV1PlaceConsumerAlert", +"properties": { +"details": { +"$ref": "GoogleMapsPlacesV1PlaceConsumerAlertDetails", +"description": "The details of the consumer alert message.\u0192" +}, +"languageCode": { +"description": "The language code of the consumer alert message. This is a BCP 47 language code.", +"type": "string" +}, +"overview": { +"description": "The overview of the consumer alert message.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleMapsPlacesV1PlaceConsumerAlertDetails": { +"description": "The details of the consumer alert message.", +"id": "GoogleMapsPlacesV1PlaceConsumerAlertDetails", +"properties": { +"aboutLink": { +"$ref": "GoogleMapsPlacesV1PlaceConsumerAlertDetailsLink", +"description": "The link to show together with the description to provide more information." +}, +"description": { +"description": "The description of the consumer alert message.", +"type": "string" +}, +"title": { +"description": "The title to show together with the description.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleMapsPlacesV1PlaceConsumerAlertDetailsLink": { +"description": "The link to show together with the description to provide more information.", +"id": "GoogleMapsPlacesV1PlaceConsumerAlertDetailsLink", +"properties": { +"title": { +"description": "The title to show for the link.", +"type": "string" +}, +"uri": { +"description": "The uri of the link.", +"type": "string" +} +}, +"type": "object" +}, "GoogleMapsPlacesV1PlaceContainingPlace": { "description": "Info about the place in which this place is located.", "id": "GoogleMapsPlacesV1PlaceContainingPlace", @@ -1850,6 +1907,10 @@ "text": { "$ref": "GoogleTypeLocalizedText", "description": "The localized text of the review." +}, +"visitDate": { +"$ref": "GoogleTypeDate", +"description": "The date when the author visited the place. This is trucated to the year and month of the visit." } }, "type": "object" From 6dfb3ed8516a78458fab64cb79abae8a96d05470 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 30 Sep 2025 07:09:37 +0000 Subject: [PATCH 32/42] feat(recaptchaenterprise): update the api #### recaptchaenterprise:v1 The following keys were added: - schemas.GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest.properties.phoneAuthenticationEvent.$ref (Total Keys: 1) - schemas.GoogleCloudRecaptchaenterpriseV1PhoneAuthenticationEvent (Total Keys: 4) --- ...chaenterprise_v1.projects.assessments.html | 4 ++++ .../documents/recaptchaenterprise.v1.json | 22 ++++++++++++++++++- 2 files changed, 25 insertions(+), 1 deletion(-) diff --git a/docs/dyn/recaptchaenterprise_v1.projects.assessments.html b/docs/dyn/recaptchaenterprise_v1.projects.assessments.html index 4ab1689359b..4078b82b24a 100644 --- a/docs/dyn/recaptchaenterprise_v1.projects.assessments.html +++ b/docs/dyn/recaptchaenterprise_v1.projects.assessments.html @@ -97,6 +97,10 @@

Method Details

"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. "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. "A String", ], diff --git a/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json b/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json index 3aa723251ce..4729f04f8bc 100644 --- a/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json +++ b/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json @@ -786,7 +786,7 @@ } } }, -"revision": "20250706", +"revision": "20250917", "rootUrl": "https://recaptchaenterprise.googleapis.com/", "schemas": { "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment": { @@ -947,6 +947,10 @@ true "format": "byte", "type": "string" }, +"phoneAuthenticationEvent": { +"$ref": "GoogleCloudRecaptchaenterpriseV1PhoneAuthenticationEvent", +"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": { @@ -1793,6 +1797,22 @@ true }, "type": "object" }, +"GoogleCloudRecaptchaenterpriseV1PhoneAuthenticationEvent": { +"description": "Details on a phone authentication event", +"id": "GoogleCloudRecaptchaenterpriseV1PhoneAuthenticationEvent", +"properties": { +"eventTime": { +"description": "Optional. The time at which the multi-factor authentication event (challenge or verification) occurred.", +"format": "google-datetime", +"type": "string" +}, +"phoneNumber": { +"description": "Required. Phone number in E.164 format for which a multi-factor authentication challenge was initiated, succeeded, or failed.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudRecaptchaenterpriseV1PhoneFraudAssessment": { "description": "Assessment for Phone Fraud", "id": "GoogleCloudRecaptchaenterpriseV1PhoneFraudAssessment", From 865353450158266e8d505f0b8170b1a0710c1f27 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 30 Sep 2025 07:09:37 +0000 Subject: [PATCH 33/42] feat(saasservicemgmt): update the api #### saasservicemgmt:v1beta1 The following keys were added: - resources.projects.resources.locations.resources.replicationsInternal.methods.create (Total Keys: 18) - resources.projects.resources.locations.resources.replicationsInternal.methods.delete (Total Keys: 15) - resources.projects.resources.locations.resources.replicationsInternal.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.replicationsInternal.methods.list (Total Keys: 20) - resources.projects.resources.locations.resources.replicationsInternal.methods.patch (Total Keys: 19) - schemas.ListReplicationsInternalResponse (Total Keys: 7) - schemas.ReplicationInternal (Total Keys: 26) - schemas.ReplicationStats (Total Keys: 13) - schemas.Status (Total Keys: 8) --- ...ervicemgmt_v1beta1.projects.locations.html | 5 + ...ojects.locations.replicationsInternal.html | 518 ++++++++++++++++++ .../documents/saasservicemgmt.v1beta1.json | 398 +++++++++++++- 3 files changed, 920 insertions(+), 1 deletion(-) create mode 100644 docs/dyn/saasservicemgmt_v1beta1.projects.locations.replicationsInternal.html diff --git a/docs/dyn/saasservicemgmt_v1beta1.projects.locations.html b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.html index 0735e31f132..5595b60631c 100644 --- a/docs/dyn/saasservicemgmt_v1beta1.projects.locations.html +++ b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.html @@ -79,6 +79,11 @@

Instance Methods

Returns the releases Resource.

+

+ replicationsInternal() +

+

Returns the replicationsInternal Resource.

+

rolloutKinds()

diff --git a/docs/dyn/saasservicemgmt_v1beta1.projects.locations.replicationsInternal.html b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.replicationsInternal.html new file mode 100644 index 00000000000..9bb7ae0765e --- /dev/null +++ b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.replicationsInternal.html @@ -0,0 +1,518 @@ + + + +

SaaS Runtime API . projects . locations . replicationsInternal

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, replicationInternalId=None, requestId=None, validateOnly=None, x__xgafv=None)

+

Create a new replication internal.

+

+ delete(name, etag=None, requestId=None, validateOnly=None, x__xgafv=None)

+

Delete a single replication internal.

+

+ get(name, x__xgafv=None)

+

Retrieve a single replication internal.

+

+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Retrieve a collection of replication internals.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(name, body=None, etag=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)

+

Update a single replication internal.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ create(parent, body=None, replicationInternalId=None, requestId=None, validateOnly=None, x__xgafv=None) + 
Create a new replication internal.
+
+Args:
+  parent: string, Required. The parent of the replication internal. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # ReplicationInternal is a resource that represents the replication of a resource to multiple locations. This is an internal resource to achieve replication before GA and will not expose to the public API.
+  "annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations
+    "a_key": "A String",
+  },
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "etag": "A String", # Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.
+  "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
+    "a_key": "A String",
+  },
+  "maxRetryCount": 42, # Optional. The maximum number of retries for the replication. If the replication fails from a retryable error, it will be retried for this number of times.
+  "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/replicationInternal/{replication_internal_id}"
+  "payload": { # Required. The payload of the request for replication. It could be any request type that is supported by the replication service. e.g. CreateUnitKindRequest, UpdateUnitKindRequest, DeleteReleaseRequest, etc.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "state": "A String", # Output only. The state of the replication.
+  "stats": { # Output only. The stats of the replication. One key for each location in target_locations
+    "a_key": { # ReplicationStats contains the stats of the replication. It contains the resources that are pending, finished, failed, and the errors if any.
+      "errors": [ # The errors that occurred during replication, one error for each failed resource.
+        { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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.
+        },
+      ],
+      "failedResources": [ # The resources that are failed replication.
+        "A String",
+      ],
+      "finishedResources": [ # The resources that are finished replication.
+        "A String",
+      ],
+      "pendingResources": [ # The resources that are pending replication.
+        "A String",
+      ],
+      "retryCount": [ # The number of retries for the failed resources.
+        42,
+      ],
+    },
+  },
+  "targetLocations": [ # Optional. The target locations to replicate the resource to.
+    "A String",
+  ],
+  "uid": "A String", # Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.
+  "updateTime": "A String", # Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value.
+}
+
+  replicationInternalId: string, Required. The ID value for the new replication internal.
+  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. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  validateOnly: boolean, If "validate_only" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # ReplicationInternal is a resource that represents the replication of a resource to multiple locations. This is an internal resource to achieve replication before GA and will not expose to the public API.
+  "annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations
+    "a_key": "A String",
+  },
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "etag": "A String", # Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.
+  "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
+    "a_key": "A String",
+  },
+  "maxRetryCount": 42, # Optional. The maximum number of retries for the replication. If the replication fails from a retryable error, it will be retried for this number of times.
+  "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/replicationInternal/{replication_internal_id}"
+  "payload": { # Required. The payload of the request for replication. It could be any request type that is supported by the replication service. e.g. CreateUnitKindRequest, UpdateUnitKindRequest, DeleteReleaseRequest, etc.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "state": "A String", # Output only. The state of the replication.
+  "stats": { # Output only. The stats of the replication. One key for each location in target_locations
+    "a_key": { # ReplicationStats contains the stats of the replication. It contains the resources that are pending, finished, failed, and the errors if any.
+      "errors": [ # The errors that occurred during replication, one error for each failed resource.
+        { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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.
+        },
+      ],
+      "failedResources": [ # The resources that are failed replication.
+        "A String",
+      ],
+      "finishedResources": [ # The resources that are finished replication.
+        "A String",
+      ],
+      "pendingResources": [ # The resources that are pending replication.
+        "A String",
+      ],
+      "retryCount": [ # The number of retries for the failed resources.
+        42,
+      ],
+    },
+  },
+  "targetLocations": [ # Optional. The target locations to replicate the resource to.
+    "A String",
+  ],
+  "uid": "A String", # Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.
+  "updateTime": "A String", # Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value.
+}
+
+ +
+ delete(name, etag=None, requestId=None, validateOnly=None, x__xgafv=None) + 
Delete a single replication internal.
+
+Args:
+  name: string, Required. The resource name of the resource within a service. (required)
+  etag: string, The etag known to the client for the expected state of the replication internal. This is used with state-changing methods to prevent accidental overwrites when multiple user agents might be acting in parallel on the same resource. An etag wildcard provide optimistic concurrency based on the expected existence of the replication internal. The Any wildcard (`*`) requires that the resource must already exists, and the Not Any wildcard (`!*`) requires that it must not.
+  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. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  validateOnly: boolean, If "validate_only" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.
+  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) + 
Retrieve a single replication internal.
+
+Args:
+  name: string, Required. The resource name of the resource within a service. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # ReplicationInternal is a resource that represents the replication of a resource to multiple locations. This is an internal resource to achieve replication before GA and will not expose to the public API.
+  "annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations
+    "a_key": "A String",
+  },
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "etag": "A String", # Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.
+  "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
+    "a_key": "A String",
+  },
+  "maxRetryCount": 42, # Optional. The maximum number of retries for the replication. If the replication fails from a retryable error, it will be retried for this number of times.
+  "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/replicationInternal/{replication_internal_id}"
+  "payload": { # Required. The payload of the request for replication. It could be any request type that is supported by the replication service. e.g. CreateUnitKindRequest, UpdateUnitKindRequest, DeleteReleaseRequest, etc.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "state": "A String", # Output only. The state of the replication.
+  "stats": { # Output only. The stats of the replication. One key for each location in target_locations
+    "a_key": { # ReplicationStats contains the stats of the replication. It contains the resources that are pending, finished, failed, and the errors if any.
+      "errors": [ # The errors that occurred during replication, one error for each failed resource.
+        { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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.
+        },
+      ],
+      "failedResources": [ # The resources that are failed replication.
+        "A String",
+      ],
+      "finishedResources": [ # The resources that are finished replication.
+        "A String",
+      ],
+      "pendingResources": [ # The resources that are pending replication.
+        "A String",
+      ],
+      "retryCount": [ # The number of retries for the failed resources.
+        42,
+      ],
+    },
+  },
+  "targetLocations": [ # Optional. The target locations to replicate the resource to.
+    "A String",
+  ],
+  "uid": "A String", # Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.
+  "updateTime": "A String", # Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) + 
Retrieve a collection of replication internals.
+
+Args:
+  parent: string, Required. The parent of the replication internal. (required)
+  filter: string, Filter the list as specified in https://google.aip.dev/160.
+  orderBy: string, Order results as specified in https://google.aip.dev/132.
+  pageSize: integer, The maximum number of replication internals to send per page.
+  pageToken: string, The page token: If the next_page_token from a previous response is provided, this request will send 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:
+
+    { # The response structure for the ListReplicationsInternal method.
+  "nextPageToken": "A String", # If present, the next page token can be provided to a subsequent ListReplicationsInternal call to list the next page. If empty, there are no more pages.
+  "replicationsInternal": [ # The resulting replication internals.
+    { # ReplicationInternal is a resource that represents the replication of a resource to multiple locations. This is an internal resource to achieve replication before GA and will not expose to the public API.
+      "annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations
+        "a_key": "A String",
+      },
+      "createTime": "A String", # Output only. The timestamp when the resource was created.
+      "etag": "A String", # Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.
+      "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
+        "a_key": "A String",
+      },
+      "maxRetryCount": 42, # Optional. The maximum number of retries for the replication. If the replication fails from a retryable error, it will be retried for this number of times.
+      "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/replicationInternal/{replication_internal_id}"
+      "payload": { # Required. The payload of the request for replication. It could be any request type that is supported by the replication service. e.g. CreateUnitKindRequest, UpdateUnitKindRequest, DeleteReleaseRequest, etc.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "state": "A String", # Output only. The state of the replication.
+      "stats": { # Output only. The stats of the replication. One key for each location in target_locations
+        "a_key": { # ReplicationStats contains the stats of the replication. It contains the resources that are pending, finished, failed, and the errors if any.
+          "errors": [ # The errors that occurred during replication, one error for each failed resource.
+            { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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.
+            },
+          ],
+          "failedResources": [ # The resources that are failed replication.
+            "A String",
+          ],
+          "finishedResources": [ # The resources that are finished replication.
+            "A String",
+          ],
+          "pendingResources": [ # The resources that are pending replication.
+            "A String",
+          ],
+          "retryCount": [ # The number of retries for the failed resources.
+            42,
+          ],
+        },
+      },
+      "targetLocations": [ # Optional. The target locations to replicate the resource to.
+        "A String",
+      ],
+      "uid": "A String", # Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.
+      "updateTime": "A String", # Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value.
+    },
+  ],
+  "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, etag=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None) + 
Update a single replication internal.
+
+Args:
+  name: string, Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/replicationInternal/{replication_internal_id}" (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # ReplicationInternal is a resource that represents the replication of a resource to multiple locations. This is an internal resource to achieve replication before GA and will not expose to the public API.
+  "annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations
+    "a_key": "A String",
+  },
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "etag": "A String", # Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.
+  "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
+    "a_key": "A String",
+  },
+  "maxRetryCount": 42, # Optional. The maximum number of retries for the replication. If the replication fails from a retryable error, it will be retried for this number of times.
+  "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/replicationInternal/{replication_internal_id}"
+  "payload": { # Required. The payload of the request for replication. It could be any request type that is supported by the replication service. e.g. CreateUnitKindRequest, UpdateUnitKindRequest, DeleteReleaseRequest, etc.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "state": "A String", # Output only. The state of the replication.
+  "stats": { # Output only. The stats of the replication. One key for each location in target_locations
+    "a_key": { # ReplicationStats contains the stats of the replication. It contains the resources that are pending, finished, failed, and the errors if any.
+      "errors": [ # The errors that occurred during replication, one error for each failed resource.
+        { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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.
+        },
+      ],
+      "failedResources": [ # The resources that are failed replication.
+        "A String",
+      ],
+      "finishedResources": [ # The resources that are finished replication.
+        "A String",
+      ],
+      "pendingResources": [ # The resources that are pending replication.
+        "A String",
+      ],
+      "retryCount": [ # The number of retries for the failed resources.
+        42,
+      ],
+    },
+  },
+  "targetLocations": [ # Optional. The target locations to replicate the resource to.
+    "A String",
+  ],
+  "uid": "A String", # Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.
+  "updateTime": "A String", # Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value.
+}
+
+  etag: string, The etag known to the client for the expected state of the replication internal. This is used with state-changing methods to prevent accidental overwrites when multiple user agents might be acting in parallel on the same resource. An etag wildcard provide optimistic concurrency based on the expected existence of the replication internal. The Any wildcard (`*`) requires that the resource must already exists, and the Not Any wildcard (`!*`) requires that it must not.
+  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. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  updateMask: string, Field mask is used to specify the fields to be overwritten in the ReplicationInternal resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields in the ReplicationInternal will be overwritten.
+  validateOnly: boolean, If "validate_only" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # ReplicationInternal is a resource that represents the replication of a resource to multiple locations. This is an internal resource to achieve replication before GA and will not expose to the public API.
+  "annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations
+    "a_key": "A String",
+  },
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "etag": "A String", # Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.
+  "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
+    "a_key": "A String",
+  },
+  "maxRetryCount": 42, # Optional. The maximum number of retries for the replication. If the replication fails from a retryable error, it will be retried for this number of times.
+  "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/replicationInternal/{replication_internal_id}"
+  "payload": { # Required. The payload of the request for replication. It could be any request type that is supported by the replication service. e.g. CreateUnitKindRequest, UpdateUnitKindRequest, DeleteReleaseRequest, etc.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "state": "A String", # Output only. The state of the replication.
+  "stats": { # Output only. The stats of the replication. One key for each location in target_locations
+    "a_key": { # ReplicationStats contains the stats of the replication. It contains the resources that are pending, finished, failed, and the errors if any.
+      "errors": [ # The errors that occurred during replication, one error for each failed resource.
+        { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find 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.
+        },
+      ],
+      "failedResources": [ # The resources that are failed replication.
+        "A String",
+      ],
+      "finishedResources": [ # The resources that are finished replication.
+        "A String",
+      ],
+      "pendingResources": [ # The resources that are pending replication.
+        "A String",
+      ],
+      "retryCount": [ # The number of retries for the failed resources.
+        42,
+      ],
+    },
+  },
+  "targetLocations": [ # Optional. The target locations to replicate the resource to.
+    "A String",
+  ],
+  "uid": "A String", # Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.
+  "updateTime": "A String", # Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value.
+}
+
+ + \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/saasservicemgmt.v1beta1.json b/googleapiclient/discovery_cache/documents/saasservicemgmt.v1beta1.json index 72b1965a206..4b8d837e77b 100644 --- a/googleapiclient/discovery_cache/documents/saasservicemgmt.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/saasservicemgmt.v1beta1.json @@ -385,6 +385,213 @@ } } }, +"replicationsInternal": { +"methods": { +"create": { +"description": "Create a new replication internal.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/replicationsInternal", +"httpMethod": "POST", +"id": "saasservicemgmt.projects.locations.replicationsInternal.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent of the replication internal.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"replicationInternalId": { +"description": "Required. The ID value for the new replication internal.", +"location": "query", +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"validateOnly": { +"description": "If \"validate_only\" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1beta1/{+parent}/replicationsInternal", +"request": { +"$ref": "ReplicationInternal" +}, +"response": { +"$ref": "ReplicationInternal" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Delete a single replication internal.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/replicationsInternal/{replicationsInternalId}", +"httpMethod": "DELETE", +"id": "saasservicemgmt.projects.locations.replicationsInternal.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"etag": { +"description": "The etag known to the client for the expected state of the replication internal. This is used with state-changing methods to prevent accidental overwrites when multiple user agents might be acting in parallel on the same resource. An etag wildcard provide optimistic concurrency based on the expected existence of the replication internal. The Any wildcard (`*`) requires that the resource must already exists, and the Not Any wildcard (`!*`) requires that it must not.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The resource name of the resource within a service.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/replicationsInternal/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"validateOnly": { +"description": "If \"validate_only\" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Retrieve a single replication internal.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/replicationsInternal/{replicationsInternalId}", +"httpMethod": "GET", +"id": "saasservicemgmt.projects.locations.replicationsInternal.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the resource within a service.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/replicationsInternal/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "ReplicationInternal" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Retrieve a collection of replication internals.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/replicationsInternal", +"httpMethod": "GET", +"id": "saasservicemgmt.projects.locations.replicationsInternal.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Filter the list as specified in https://google.aip.dev/160.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Order results as specified in https://google.aip.dev/132.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "The maximum number of replication internals to send per page.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The page token: If the next_page_token from a previous response is provided, this request will send the subsequent page.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent of the replication internal.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/replicationsInternal", +"response": { +"$ref": "ListReplicationsInternalResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Update a single replication internal.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/replicationsInternal/{replicationsInternalId}", +"httpMethod": "PATCH", +"id": "saasservicemgmt.projects.locations.replicationsInternal.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"etag": { +"description": "The etag known to the client for the expected state of the replication internal. This is used with state-changing methods to prevent accidental overwrites when multiple user agents might be acting in parallel on the same resource. An etag wildcard provide optimistic concurrency based on the expected existence of the replication internal. The Any wildcard (`*`) requires that the resource must already exists, and the Not Any wildcard (`!*`) requires that it must not.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Identifier. The resource name (full URI of the resource) following the standard naming scheme: \"projects/{project}/locations/{location}/replicationInternal/{replication_internal_id}\"", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/replicationsInternal/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"updateMask": { +"description": "Field mask is used to specify the fields to be overwritten in the ReplicationInternal resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields in the ReplicationInternal will be overwritten.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +}, +"validateOnly": { +"description": "If \"validate_only\" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1beta1/{+name}", +"request": { +"$ref": "ReplicationInternal" +}, +"response": { +"$ref": "ReplicationInternal" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "rolloutKinds": { "methods": { "create": { @@ -1804,7 +2011,7 @@ } } }, -"revision": "20250910", +"revision": "20250917", "rootUrl": "https://saasservicemgmt.googleapis.com/", "schemas": { "Aggregate": { @@ -1980,6 +2187,31 @@ }, "type": "object" }, +"ListReplicationsInternalResponse": { +"description": "The response structure for the ListReplicationsInternal method.", +"id": "ListReplicationsInternalResponse", +"properties": { +"nextPageToken": { +"description": "If present, the next page token can be provided to a subsequent ListReplicationsInternal call to list the next page. If empty, there are no more pages.", +"type": "string" +}, +"replicationsInternal": { +"description": "The resulting replication internals.", +"items": { +"$ref": "ReplicationInternal" +}, +"type": "array" +}, +"unreachable": { +"description": "Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "ListRolloutKindsResponse": { "description": "The response structure for the ListRolloutKinds method.", "id": "ListRolloutKindsResponse", @@ -2292,6 +2524,143 @@ }, "type": "object" }, +"ReplicationInternal": { +"description": "ReplicationInternal is a resource that represents the replication of a resource to multiple locations. This is an internal resource to achieve replication before GA and will not expose to the public API.", +"id": "ReplicationInternal", +"properties": { +"annotations": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations", +"type": "object" +}, +"createTime": { +"description": "Output only. The timestamp when the resource was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"etag": { +"description": "Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.", +"readOnly": true, +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.", +"type": "object" +}, +"maxRetryCount": { +"description": "Optional. The maximum number of retries for the replication. If the replication fails from a retryable error, it will be retried for this number of times.", +"format": "int32", +"type": "integer" +}, +"name": { +"description": "Identifier. The resource name (full URI of the resource) following the standard naming scheme: \"projects/{project}/locations/{location}/replicationInternal/{replication_internal_id}\"", +"type": "string" +}, +"payload": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"description": "Required. The payload of the request for replication. It could be any request type that is supported by the replication service. e.g. CreateUnitKindRequest, UpdateUnitKindRequest, DeleteReleaseRequest, etc.", +"type": "object" +}, +"state": { +"description": "Output only. The state of the replication.", +"enum": [ +"REPLICATION_STATE_UNSPECIFIED", +"REPLICATION_STATE_PENDING", +"REPLICATION_STATE_RUNNING", +"REPLICATION_STATE_FAILED", +"REPLICATION_STATE_SUCCEEDED" +], +"enumDescriptions": [ +"Unspecified state.", +"Replication is pending.", +"Replication is running.", +"Replication has failed.", +"Replication has succeeded." +], +"readOnly": true, +"type": "string" +}, +"stats": { +"additionalProperties": { +"$ref": "ReplicationStats" +}, +"description": "Output only. The stats of the replication. One key for each location in target_locations", +"readOnly": true, +"type": "object" +}, +"targetLocations": { +"description": "Optional. The target locations to replicate the resource to.", +"items": { +"type": "string" +}, +"type": "array" +}, +"uid": { +"description": "Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.", +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"ReplicationStats": { +"description": "ReplicationStats contains the stats of the replication. It contains the resources that are pending, finished, failed, and the errors if any.", +"id": "ReplicationStats", +"properties": { +"errors": { +"description": "The errors that occurred during replication, one error for each failed resource.", +"items": { +"$ref": "Status" +}, +"type": "array" +}, +"failedResources": { +"description": "The resources that are failed replication.", +"items": { +"type": "string" +}, +"type": "array" +}, +"finishedResources": { +"description": "The resources that are finished replication.", +"items": { +"type": "string" +}, +"type": "array" +}, +"pendingResources": { +"description": "The resources that are pending replication.", +"items": { +"type": "string" +}, +"type": "array" +}, +"retryCount": { +"description": "The number of retries for the failed resources.", +"items": { +"format": "int32", +"type": "integer" +}, +"type": "array" +} +}, +"type": "object" +}, "Rollout": { "description": "Represents a single rollout execution and its results", "id": "Rollout", @@ -2622,6 +2991,33 @@ }, "type": "object" }, +"Status": { +"description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", +"id": "Status", +"properties": { +"code": { +"description": "The status code, which should be an enum value of google.rpc.Code.", +"format": "int32", +"type": "integer" +}, +"details": { +"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", +"items": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", +"type": "string" +} +}, +"type": "object" +}, "Tenant": { "description": "Tenant represents the service producer side of an instance of the service created based on a request from a consumer. In a typical scenario a Tenant has a one-to-one mapping with a resource given out to a service consumer. Example: tenant: name: \"projects/svc1/locations/loc/tenants/inst-068afff8\" consumer_resource: \"projects/gshoe/locations/loc/shoes/black-shoe\"", "id": "Tenant", From 6b819e78e9003619a9ffca9811358f407eebaf83 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 30 Sep 2025 07:09:37 +0000 Subject: [PATCH 34/42] feat(serviceconsumermanagement): update the api #### serviceconsumermanagement:v1 The following keys were added: - schemas.Api.properties.edition.type (Total Keys: 1) - schemas.Method.properties.edition (Total Keys: 2) - schemas.Method.properties.syntax.deprecated (Total Keys: 1) #### serviceconsumermanagement:v1beta1 The following keys were added: - schemas.Api.properties.edition.type (Total Keys: 1) - schemas.Method.properties.edition (Total Keys: 2) - schemas.Method.properties.syntax.deprecated (Total Keys: 1) --- .../serviceconsumermanagement.v1.json | 31 +++++++++++++------ .../serviceconsumermanagement.v1beta1.json | 31 +++++++++++++------ 2 files changed, 42 insertions(+), 20 deletions(-) diff --git a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json index a32360d08c7..9b5bfd1faed 100644 --- a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json @@ -542,7 +542,7 @@ } } }, -"revision": "20250619", +"revision": "20250919", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "AddTenantProjectRequest": { @@ -561,9 +561,13 @@ "type": "object" }, "Api": { -"description": "Api is a light-weight descriptor for an API Interface. Interfaces are also described as \"protocol buffer services\" in some contexts, such as by the \"service\" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as \"APIs\" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology.", +"description": "Api is a light-weight descriptor for an API Interface. Interfaces are also described as \"protocol buffer services\" in some contexts, such as by the \"service\" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as \"APIs\" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. New usages of this message as an alternative to ServiceDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "Api", "properties": { +"edition": { +"description": "The source edition string, only valid when syntax is SYNTAX_EDITIONS.", +"type": "string" +}, "methods": { "description": "The methods of this interface, in unspecified order.", "items": { @@ -821,6 +825,7 @@ "type": "object" }, "pathTranslation": { +"description": "no-lint", "enum": [ "PATH_TRANSLATION_UNSPECIFIED", "CONSTANT_ADDRESS", @@ -1397,7 +1402,7 @@ "type": "object" }, "Enum": { -"description": "Enum type definition.", +"description": "Enum type definition. New usages of this message as an alternative to EnumDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "Enum", "properties": { "edition": { @@ -1444,7 +1449,7 @@ "type": "object" }, "EnumValue": { -"description": "Enum value definition.", +"description": "Enum value definition. New usages of this message as an alternative to EnumValueDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "EnumValue", "properties": { "name": { @@ -1486,7 +1491,7 @@ "type": "object" }, "Field": { -"description": "A single field of a message type.", +"description": "A single field of a message type. New usages of this message as an alternative to FieldDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "Field", "properties": { "cardinality": { @@ -1622,7 +1627,7 @@ "additionalProperties": { "type": "string" }, -"description": "Map of service names to renamed services. Keys are the package relative service names and values are the name to be used for the service client and call options. publishing: go_settings: renamed_services: Publisher: TopicAdmin", +"description": "Map of service names to renamed services. Keys are the package relative service names and values are the name to be used for the service client and call options. Example: publishing: go_settings: renamed_services: Publisher: TopicAdmin", "type": "object" } }, @@ -1899,9 +1904,14 @@ "type": "object" }, "Method": { -"description": "Method represents a method of an API interface.", +"description": "Method represents a method of an API interface. New usages of this message as an alternative to MethodDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "Method", "properties": { +"edition": { +"deprecated": true, +"description": "The source edition string, only valid when syntax is SYNTAX_EDITIONS. This field should be ignored, instead the edition should be inherited from Api. This is similar to Field and EnumValue.", +"type": "string" +}, "name": { "description": "The simple name of this method.", "type": "string" @@ -1930,7 +1940,8 @@ "type": "string" }, "syntax": { -"description": "The source syntax of this method.", +"deprecated": true, +"description": "The source syntax of this method. This field should be ignored, instead the syntax should be inherited from Api. This is similar to Field and EnumValue.", "enum": [ "SYNTAX_PROTO2", "SYNTAX_PROTO3", @@ -2343,7 +2354,7 @@ "type": "object" }, "Option": { -"description": "A protocol buffer option, which can be attached to a message, field, enumeration, etc.", +"description": "A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged.", "id": "Option", "properties": { "name": { @@ -3042,7 +3053,7 @@ "type": "object" }, "Type": { -"description": "A protocol buffer message type.", +"description": "A protocol buffer message type. New usages of this message as an alternative to DescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "Type", "properties": { "edition": { diff --git a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json index e5d6b274460..41825cfbf55 100644 --- a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json @@ -724,13 +724,17 @@ } } }, -"revision": "20250619", +"revision": "20250919", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "Api": { -"description": "Api is a light-weight descriptor for an API Interface. Interfaces are also described as \"protocol buffer services\" in some contexts, such as by the \"service\" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as \"APIs\" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology.", +"description": "Api is a light-weight descriptor for an API Interface. Interfaces are also described as \"protocol buffer services\" in some contexts, such as by the \"service\" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as \"APIs\" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. New usages of this message as an alternative to ServiceDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "Api", "properties": { +"edition": { +"description": "The source edition string, only valid when syntax is SYNTAX_EDITIONS.", +"type": "string" +}, "methods": { "description": "The methods of this interface, in unspecified order.", "items": { @@ -954,6 +958,7 @@ "type": "object" }, "pathTranslation": { +"description": "no-lint", "enum": [ "PATH_TRANSLATION_UNSPECIFIED", "CONSTANT_ADDRESS", @@ -1491,7 +1496,7 @@ "type": "object" }, "Enum": { -"description": "Enum type definition.", +"description": "Enum type definition. New usages of this message as an alternative to EnumDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "Enum", "properties": { "edition": { @@ -1538,7 +1543,7 @@ "type": "object" }, "EnumValue": { -"description": "Enum value definition.", +"description": "Enum value definition. New usages of this message as an alternative to EnumValueDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "EnumValue", "properties": { "name": { @@ -1580,7 +1585,7 @@ "type": "object" }, "Field": { -"description": "A single field of a message type.", +"description": "A single field of a message type. New usages of this message as an alternative to FieldDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "Field", "properties": { "cardinality": { @@ -1716,7 +1721,7 @@ "additionalProperties": { "type": "string" }, -"description": "Map of service names to renamed services. Keys are the package relative service names and values are the name to be used for the service client and call options. publishing: go_settings: renamed_services: Publisher: TopicAdmin", +"description": "Map of service names to renamed services. Keys are the package relative service names and values are the name to be used for the service client and call options. Example: publishing: go_settings: renamed_services: Publisher: TopicAdmin", "type": "object" } }, @@ -1957,9 +1962,14 @@ "type": "object" }, "Method": { -"description": "Method represents a method of an API interface.", +"description": "Method represents a method of an API interface. New usages of this message as an alternative to MethodDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "Method", "properties": { +"edition": { +"deprecated": true, +"description": "The source edition string, only valid when syntax is SYNTAX_EDITIONS. This field should be ignored, instead the edition should be inherited from Api. This is similar to Field and EnumValue.", +"type": "string" +}, "name": { "description": "The simple name of this method.", "type": "string" @@ -1988,7 +1998,8 @@ "type": "string" }, "syntax": { -"description": "The source syntax of this method.", +"deprecated": true, +"description": "The source syntax of this method. This field should be ignored, instead the syntax should be inherited from Api. This is similar to Field and EnumValue.", "enum": [ "SYNTAX_PROTO2", "SYNTAX_PROTO3", @@ -2401,7 +2412,7 @@ "type": "object" }, "Option": { -"description": "A protocol buffer option, which can be attached to a message, field, enumeration, etc.", +"description": "A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged.", "id": "Option", "properties": { "name": { @@ -2914,7 +2925,7 @@ "type": "object" }, "Type": { -"description": "A protocol buffer message type.", +"description": "A protocol buffer message type. New usages of this message as an alternative to DescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "Type", "properties": { "edition": { From 8fbaca3ec2a60c9c9bfbda5c93980e66cff07bad Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 30 Sep 2025 07:09:37 +0000 Subject: [PATCH 35/42] feat(servicemanagement): update the api #### servicemanagement:v1 The following keys were deleted: - schemas.Rollout.properties.universe.type (Total Keys: 1) The following keys were added: - schemas.Api.properties.edition.type (Total Keys: 1) - schemas.Method.properties.edition (Total Keys: 2) - schemas.Method.properties.syntax.deprecated (Total Keys: 1) - schemas.PhpSettings.properties.libraryPackage.type (Total Keys: 1) --- ...servicemanagement_v1.services.configs.html | 164 ++++++++++-------- docs/dyn/servicemanagement_v1.services.html | 41 +++-- ...ervicemanagement_v1.services.rollouts.html | 3 - .../documents/servicemanagement.v1.json | 41 +++-- 4 files changed, 136 insertions(+), 113 deletions(-) diff --git a/docs/dyn/servicemanagement_v1.services.configs.html b/docs/dyn/servicemanagement_v1.services.configs.html index 757c92cbedf..1888af27758 100644 --- a/docs/dyn/servicemanagement_v1.services.configs.html +++ b/docs/dyn/servicemanagement_v1.services.configs.html @@ -109,12 +109,14 @@

Method Details

{ # `Service` is the root object of Google API service configuration (service config). It describes the basic information about a logical service, such as the service name and the user-facing title, and delegates other aspects to sub-sections. Each sub-section is either a proto message or a repeated proto message that configures a specific aspect, such as auth. For more information, see each proto message definition. Example: type: google.api.Service name: calendar.googleapis.com title: Google Calendar API apis: - name: google.calendar.v3.Calendar visibility: rules: - selector: "google.calendar.v3.*" restriction: PREVIEW backend: rules: - selector: "google.calendar.v3.*" address: calendar.example.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth "apis": [ # A list of API interfaces exported by this service. Only the `name` field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files. - { # Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. + { # Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. New usages of this message as an alternative to ServiceDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. + "edition": "A String", # The source edition string, only valid when syntax is SYNTAX_EDITIONS. "methods": [ # The methods of this interface, in unspecified order. - { # Method represents a method of an API interface. + { # Method represents a method of an API interface. New usages of this message as an alternative to MethodDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. + "edition": "A String", # The source edition string, only valid when syntax is SYNTAX_EDITIONS. This field should be ignored, instead the edition should be inherited from Api. This is similar to Field and EnumValue. "name": "A String", # The simple name of this method. "options": [ # Any metadata attached to the method. - { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. + { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. "name": "A String", # The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. "value": { # The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -125,7 +127,7 @@

Method Details

"requestTypeUrl": "A String", # A URL of the input message type. "responseStreaming": True or False, # If true, the response is streamed. "responseTypeUrl": "A String", # The URL of the output message type. - "syntax": "A String", # The source syntax of this method. + "syntax": "A String", # The source syntax of this method. This field should be ignored, instead the syntax should be inherited from Api. This is similar to Field and EnumValue. }, ], "mixins": [ # Included interfaces. See Mixin. @@ -136,7 +138,7 @@

Method Details

], "name": "A String", # The fully qualified name of this interface, including package name followed by the interface's simple name. "options": [ # Any metadata attached to the interface. - { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. + { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. "name": "A String", # The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. "value": { # The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -205,7 +207,7 @@

Method Details

"overridesByRequestProtocol": { # The map between request protocol and the backend address. "a_key": # Object with schema name: BackendRule }, - "pathTranslation": "A String", + "pathTranslation": "A String", # no-lint "protocol": "A String", # The protocol used for sending a request to the backend. The supported values are "http/1.1" and "h2". The default value is inferred from the scheme in the address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this field to "h2" for improved performance. Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends. See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values. "selector": "A String", # Selects the methods to which this rule applies. Refer to selector for syntax details. }, @@ -311,14 +313,14 @@

Method Details

}, ], "enums": [ # A list of all enum types included in this API service. Enums referenced directly or indirectly by the `apis` are automatically included. Enums which are not referenced but shall be included should be listed here by name by the configuration author. Example: enums: - name: google.someapi.v1.SomeEnum - { # Enum type definition. + { # Enum type definition. New usages of this message as an alternative to EnumDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. "edition": "A String", # The source edition string, only valid when syntax is SYNTAX_EDITIONS. "enumvalue": [ # Enum value definitions. - { # Enum value definition. + { # Enum value definition. New usages of this message as an alternative to EnumValueDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. "name": "A String", # Enum value name. "number": 42, # Enum value number. "options": [ # Protocol buffer options. - { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. + { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. "name": "A String", # The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. "value": { # The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -329,7 +331,7 @@

Method Details

], "name": "A String", # Enum type name. "options": [ # Protocol buffer options. - { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. + { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. "name": "A String", # The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. "value": { # The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -529,7 +531,7 @@

Method Details

], }, }, - "renamedServices": { # Map of service names to renamed services. Keys are the package relative service names and values are the name to be used for the service client and call options. publishing: go_settings: renamed_services: Publisher: TopicAdmin + "renamedServices": { # Map of service names to renamed services. Keys are the package relative service names and values are the name to be used for the service client and call options. Example: publishing: go_settings: renamed_services: Publisher: TopicAdmin "a_key": "A String", }, }, @@ -579,6 +581,7 @@

Method Details

], }, }, + "libraryPackage": "A String", # The package name to use in Php. Clobbers the php_namespace option set in the protobuf. This should be used **only** by APIs who have already set the language_settings.php.package_name" field in gapic.yaml. API teams should use the protobuf php_namespace option where possible. Example of a YAML configuration:: publishing: library_settings: php_settings: library_package: Google\Cloud\PubSub\V1 }, "pythonSettings": { # Settings for Python client libraries. # Settings for Python client libraries. "common": { # Required information for every language. # Some settings. @@ -703,10 +706,10 @@

Method Details

], }, "systemTypes": [ # A list of all proto message types included in this API service. It serves similar purpose as [google.api.Service.types], except that these types are not needed by user-defined APIs. Therefore, they will not show up in the generated discovery doc. This field should only be used to define system APIs in ESF. - { # A protocol buffer message type. + { # A protocol buffer message type. New usages of this message as an alternative to DescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. "edition": "A String", # The source edition string, only valid when syntax is SYNTAX_EDITIONS. "fields": [ # The list of fields. - { # A single field of a message type. + { # A single field of a message type. New usages of this message as an alternative to FieldDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. "cardinality": "A String", # The field cardinality. "defaultValue": "A String", # The string value of the default value of this field. Proto2 syntax only. "jsonName": "A String", # The field JSON name. @@ -715,7 +718,7 @@

Method Details

"number": 42, # The field number. "oneofIndex": 42, # The index of the field type in `Type.oneofs`, for message or enumeration types. The first type has index 1; zero means the type is not in the list. "options": [ # The protocol buffer options. - { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. + { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. "name": "A String", # The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. "value": { # The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -731,7 +734,7 @@

Method Details

"A String", ], "options": [ # The protocol buffer options. - { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. + { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. "name": "A String", # The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. "value": { # The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -746,10 +749,10 @@

Method Details

], "title": "A String", # The product title for this service, it is the name displayed in Google Cloud Console. "types": [ # A list of all proto message types included in this API service. Types referenced directly or indirectly by the `apis` are automatically included. Messages which are not referenced but shall be included, such as types used by the `google.protobuf.Any` type, should be listed here by name by the configuration author. Example: types: - name: google.protobuf.Int32 - { # A protocol buffer message type. + { # A protocol buffer message type. New usages of this message as an alternative to DescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. "edition": "A String", # The source edition string, only valid when syntax is SYNTAX_EDITIONS. "fields": [ # The list of fields. - { # A single field of a message type. + { # A single field of a message type. New usages of this message as an alternative to FieldDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. "cardinality": "A String", # The field cardinality. "defaultValue": "A String", # The string value of the default value of this field. Proto2 syntax only. "jsonName": "A String", # The field JSON name. @@ -758,7 +761,7 @@

Method Details

"number": 42, # The field number. "oneofIndex": 42, # The index of the field type in `Type.oneofs`, for message or enumeration types. The first type has index 1; zero means the type is not in the list. "options": [ # The protocol buffer options. - { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. + { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. "name": "A String", # The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. "value": { # The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -774,7 +777,7 @@

Method Details

"A String", ], "options": [ # The protocol buffer options. - { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. + { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. "name": "A String", # The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. "value": { # The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -812,12 +815,14 @@

Method Details

{ # `Service` is the root object of Google API service configuration (service config). It describes the basic information about a logical service, such as the service name and the user-facing title, and delegates other aspects to sub-sections. Each sub-section is either a proto message or a repeated proto message that configures a specific aspect, such as auth. For more information, see each proto message definition. Example: type: google.api.Service name: calendar.googleapis.com title: Google Calendar API apis: - name: google.calendar.v3.Calendar visibility: rules: - selector: "google.calendar.v3.*" restriction: PREVIEW backend: rules: - selector: "google.calendar.v3.*" address: calendar.example.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth "apis": [ # A list of API interfaces exported by this service. Only the `name` field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files. - { # Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. + { # Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. New usages of this message as an alternative to ServiceDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. + "edition": "A String", # The source edition string, only valid when syntax is SYNTAX_EDITIONS. "methods": [ # The methods of this interface, in unspecified order. - { # Method represents a method of an API interface. + { # Method represents a method of an API interface. New usages of this message as an alternative to MethodDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. + "edition": "A String", # The source edition string, only valid when syntax is SYNTAX_EDITIONS. This field should be ignored, instead the edition should be inherited from Api. This is similar to Field and EnumValue. "name": "A String", # The simple name of this method. "options": [ # Any metadata attached to the method. - { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. + { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. "name": "A String", # The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. "value": { # The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -828,7 +833,7 @@

Method Details

"requestTypeUrl": "A String", # A URL of the input message type. "responseStreaming": True or False, # If true, the response is streamed. "responseTypeUrl": "A String", # The URL of the output message type. - "syntax": "A String", # The source syntax of this method. + "syntax": "A String", # The source syntax of this method. This field should be ignored, instead the syntax should be inherited from Api. This is similar to Field and EnumValue. }, ], "mixins": [ # Included interfaces. See Mixin. @@ -839,7 +844,7 @@

Method Details

], "name": "A String", # The fully qualified name of this interface, including package name followed by the interface's simple name. "options": [ # Any metadata attached to the interface. - { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. + { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. "name": "A String", # The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. "value": { # The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -908,7 +913,7 @@

Method Details

"overridesByRequestProtocol": { # The map between request protocol and the backend address. "a_key": # Object with schema name: BackendRule }, - "pathTranslation": "A String", + "pathTranslation": "A String", # no-lint "protocol": "A String", # The protocol used for sending a request to the backend. The supported values are "http/1.1" and "h2". The default value is inferred from the scheme in the address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this field to "h2" for improved performance. Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends. See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values. "selector": "A String", # Selects the methods to which this rule applies. Refer to selector for syntax details. }, @@ -1014,14 +1019,14 @@

Method Details

}, ], "enums": [ # A list of all enum types included in this API service. Enums referenced directly or indirectly by the `apis` are automatically included. Enums which are not referenced but shall be included should be listed here by name by the configuration author. Example: enums: - name: google.someapi.v1.SomeEnum - { # Enum type definition. + { # Enum type definition. New usages of this message as an alternative to EnumDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. "edition": "A String", # The source edition string, only valid when syntax is SYNTAX_EDITIONS. "enumvalue": [ # Enum value definitions. - { # Enum value definition. + { # Enum value definition. New usages of this message as an alternative to EnumValueDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. "name": "A String", # Enum value name. "number": 42, # Enum value number. "options": [ # Protocol buffer options. - { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. + { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. "name": "A String", # The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. "value": { # The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -1032,7 +1037,7 @@

Method Details

], "name": "A String", # Enum type name. "options": [ # Protocol buffer options. - { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. + { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. "name": "A String", # The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. "value": { # The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -1232,7 +1237,7 @@

Method Details

], }, }, - "renamedServices": { # Map of service names to renamed services. Keys are the package relative service names and values are the name to be used for the service client and call options. publishing: go_settings: renamed_services: Publisher: TopicAdmin + "renamedServices": { # Map of service names to renamed services. Keys are the package relative service names and values are the name to be used for the service client and call options. Example: publishing: go_settings: renamed_services: Publisher: TopicAdmin "a_key": "A String", }, }, @@ -1282,6 +1287,7 @@

Method Details

], }, }, + "libraryPackage": "A String", # The package name to use in Php. Clobbers the php_namespace option set in the protobuf. This should be used **only** by APIs who have already set the language_settings.php.package_name" field in gapic.yaml. API teams should use the protobuf php_namespace option where possible. Example of a YAML configuration:: publishing: library_settings: php_settings: library_package: Google\Cloud\PubSub\V1 }, "pythonSettings": { # Settings for Python client libraries. # Settings for Python client libraries. "common": { # Required information for every language. # Some settings. @@ -1406,10 +1412,10 @@

Method Details

], }, "systemTypes": [ # A list of all proto message types included in this API service. It serves similar purpose as [google.api.Service.types], except that these types are not needed by user-defined APIs. Therefore, they will not show up in the generated discovery doc. This field should only be used to define system APIs in ESF. - { # A protocol buffer message type. + { # A protocol buffer message type. New usages of this message as an alternative to DescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. "edition": "A String", # The source edition string, only valid when syntax is SYNTAX_EDITIONS. "fields": [ # The list of fields. - { # A single field of a message type. + { # A single field of a message type. New usages of this message as an alternative to FieldDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. "cardinality": "A String", # The field cardinality. "defaultValue": "A String", # The string value of the default value of this field. Proto2 syntax only. "jsonName": "A String", # The field JSON name. @@ -1418,7 +1424,7 @@

Method Details

"number": 42, # The field number. "oneofIndex": 42, # The index of the field type in `Type.oneofs`, for message or enumeration types. The first type has index 1; zero means the type is not in the list. "options": [ # The protocol buffer options. - { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. + { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. "name": "A String", # The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. "value": { # The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -1434,7 +1440,7 @@

Method Details

"A String", ], "options": [ # The protocol buffer options. - { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. + { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. "name": "A String", # The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. "value": { # The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -1449,10 +1455,10 @@

Method Details

], "title": "A String", # The product title for this service, it is the name displayed in Google Cloud Console. "types": [ # A list of all proto message types included in this API service. Types referenced directly or indirectly by the `apis` are automatically included. Messages which are not referenced but shall be included, such as types used by the `google.protobuf.Any` type, should be listed here by name by the configuration author. Example: types: - name: google.protobuf.Int32 - { # A protocol buffer message type. + { # A protocol buffer message type. New usages of this message as an alternative to DescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. "edition": "A String", # The source edition string, only valid when syntax is SYNTAX_EDITIONS. "fields": [ # The list of fields. - { # A single field of a message type. + { # A single field of a message type. New usages of this message as an alternative to FieldDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. "cardinality": "A String", # The field cardinality. "defaultValue": "A String", # The string value of the default value of this field. Proto2 syntax only. "jsonName": "A String", # The field JSON name. @@ -1461,7 +1467,7 @@

Method Details

"number": 42, # The field number. "oneofIndex": 42, # The index of the field type in `Type.oneofs`, for message or enumeration types. The first type has index 1; zero means the type is not in the list. "options": [ # The protocol buffer options. - { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. + { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. "name": "A String", # The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. "value": { # The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -1477,7 +1483,7 @@

Method Details

"A String", ], "options": [ # The protocol buffer options. - { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. + { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. "name": "A String", # The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. "value": { # The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -1527,12 +1533,14 @@

Method Details

{ # `Service` is the root object of Google API service configuration (service config). It describes the basic information about a logical service, such as the service name and the user-facing title, and delegates other aspects to sub-sections. Each sub-section is either a proto message or a repeated proto message that configures a specific aspect, such as auth. For more information, see each proto message definition. Example: type: google.api.Service name: calendar.googleapis.com title: Google Calendar API apis: - name: google.calendar.v3.Calendar visibility: rules: - selector: "google.calendar.v3.*" restriction: PREVIEW backend: rules: - selector: "google.calendar.v3.*" address: calendar.example.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth "apis": [ # A list of API interfaces exported by this service. Only the `name` field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files. - { # Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. + { # Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. New usages of this message as an alternative to ServiceDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. + "edition": "A String", # The source edition string, only valid when syntax is SYNTAX_EDITIONS. "methods": [ # The methods of this interface, in unspecified order. - { # Method represents a method of an API interface. + { # Method represents a method of an API interface. New usages of this message as an alternative to MethodDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. + "edition": "A String", # The source edition string, only valid when syntax is SYNTAX_EDITIONS. This field should be ignored, instead the edition should be inherited from Api. This is similar to Field and EnumValue. "name": "A String", # The simple name of this method. "options": [ # Any metadata attached to the method. - { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. + { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. "name": "A String", # The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. "value": { # The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -1543,7 +1551,7 @@

Method Details

"requestTypeUrl": "A String", # A URL of the input message type. "responseStreaming": True or False, # If true, the response is streamed. "responseTypeUrl": "A String", # The URL of the output message type. - "syntax": "A String", # The source syntax of this method. + "syntax": "A String", # The source syntax of this method. This field should be ignored, instead the syntax should be inherited from Api. This is similar to Field and EnumValue. }, ], "mixins": [ # Included interfaces. See Mixin. @@ -1554,7 +1562,7 @@

Method Details

], "name": "A String", # The fully qualified name of this interface, including package name followed by the interface's simple name. "options": [ # Any metadata attached to the interface. - { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. + { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. "name": "A String", # The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. "value": { # The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -1623,7 +1631,7 @@

Method Details

"overridesByRequestProtocol": { # The map between request protocol and the backend address. "a_key": # Object with schema name: BackendRule }, - "pathTranslation": "A String", + "pathTranslation": "A String", # no-lint "protocol": "A String", # The protocol used for sending a request to the backend. The supported values are "http/1.1" and "h2". The default value is inferred from the scheme in the address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this field to "h2" for improved performance. Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends. See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values. "selector": "A String", # Selects the methods to which this rule applies. Refer to selector for syntax details. }, @@ -1729,14 +1737,14 @@

Method Details

}, ], "enums": [ # A list of all enum types included in this API service. Enums referenced directly or indirectly by the `apis` are automatically included. Enums which are not referenced but shall be included should be listed here by name by the configuration author. Example: enums: - name: google.someapi.v1.SomeEnum - { # Enum type definition. + { # Enum type definition. New usages of this message as an alternative to EnumDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. "edition": "A String", # The source edition string, only valid when syntax is SYNTAX_EDITIONS. "enumvalue": [ # Enum value definitions. - { # Enum value definition. + { # Enum value definition. New usages of this message as an alternative to EnumValueDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. "name": "A String", # Enum value name. "number": 42, # Enum value number. "options": [ # Protocol buffer options. - { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. + { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. "name": "A String", # The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. "value": { # The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -1747,7 +1755,7 @@

Method Details

], "name": "A String", # Enum type name. "options": [ # Protocol buffer options. - { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. + { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. "name": "A String", # The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. "value": { # The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -1947,7 +1955,7 @@

Method Details

], }, }, - "renamedServices": { # Map of service names to renamed services. Keys are the package relative service names and values are the name to be used for the service client and call options. publishing: go_settings: renamed_services: Publisher: TopicAdmin + "renamedServices": { # Map of service names to renamed services. Keys are the package relative service names and values are the name to be used for the service client and call options. Example: publishing: go_settings: renamed_services: Publisher: TopicAdmin "a_key": "A String", }, }, @@ -1997,6 +2005,7 @@

Method Details

], }, }, + "libraryPackage": "A String", # The package name to use in Php. Clobbers the php_namespace option set in the protobuf. This should be used **only** by APIs who have already set the language_settings.php.package_name" field in gapic.yaml. API teams should use the protobuf php_namespace option where possible. Example of a YAML configuration:: publishing: library_settings: php_settings: library_package: Google\Cloud\PubSub\V1 }, "pythonSettings": { # Settings for Python client libraries. # Settings for Python client libraries. "common": { # Required information for every language. # Some settings. @@ -2121,10 +2130,10 @@

Method Details

], }, "systemTypes": [ # A list of all proto message types included in this API service. It serves similar purpose as [google.api.Service.types], except that these types are not needed by user-defined APIs. Therefore, they will not show up in the generated discovery doc. This field should only be used to define system APIs in ESF. - { # A protocol buffer message type. + { # A protocol buffer message type. New usages of this message as an alternative to DescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. "edition": "A String", # The source edition string, only valid when syntax is SYNTAX_EDITIONS. "fields": [ # The list of fields. - { # A single field of a message type. + { # A single field of a message type. New usages of this message as an alternative to FieldDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. "cardinality": "A String", # The field cardinality. "defaultValue": "A String", # The string value of the default value of this field. Proto2 syntax only. "jsonName": "A String", # The field JSON name. @@ -2133,7 +2142,7 @@

Method Details

"number": 42, # The field number. "oneofIndex": 42, # The index of the field type in `Type.oneofs`, for message or enumeration types. The first type has index 1; zero means the type is not in the list. "options": [ # The protocol buffer options. - { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. + { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. "name": "A String", # The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. "value": { # The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -2149,7 +2158,7 @@

Method Details

"A String", ], "options": [ # The protocol buffer options. - { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. + { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. "name": "A String", # The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. "value": { # The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -2164,10 +2173,10 @@

Method Details

], "title": "A String", # The product title for this service, it is the name displayed in Google Cloud Console. "types": [ # A list of all proto message types included in this API service. Types referenced directly or indirectly by the `apis` are automatically included. Messages which are not referenced but shall be included, such as types used by the `google.protobuf.Any` type, should be listed here by name by the configuration author. Example: types: - name: google.protobuf.Int32 - { # A protocol buffer message type. + { # A protocol buffer message type. New usages of this message as an alternative to DescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. "edition": "A String", # The source edition string, only valid when syntax is SYNTAX_EDITIONS. "fields": [ # The list of fields. - { # A single field of a message type. + { # A single field of a message type. New usages of this message as an alternative to FieldDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. "cardinality": "A String", # The field cardinality. "defaultValue": "A String", # The string value of the default value of this field. Proto2 syntax only. "jsonName": "A String", # The field JSON name. @@ -2176,7 +2185,7 @@

Method Details

"number": 42, # The field number. "oneofIndex": 42, # The index of the field type in `Type.oneofs`, for message or enumeration types. The first type has index 1; zero means the type is not in the list. "options": [ # The protocol buffer options. - { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. + { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. "name": "A String", # The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. "value": { # The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -2192,7 +2201,7 @@

Method Details

"A String", ], "options": [ # The protocol buffer options. - { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. + { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. "name": "A String", # The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. "value": { # The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -2242,12 +2251,14 @@

Method Details

"serviceConfigs": [ # The list of service configuration resources. { # `Service` is the root object of Google API service configuration (service config). It describes the basic information about a logical service, such as the service name and the user-facing title, and delegates other aspects to sub-sections. Each sub-section is either a proto message or a repeated proto message that configures a specific aspect, such as auth. For more information, see each proto message definition. Example: type: google.api.Service name: calendar.googleapis.com title: Google Calendar API apis: - name: google.calendar.v3.Calendar visibility: rules: - selector: "google.calendar.v3.*" restriction: PREVIEW backend: rules: - selector: "google.calendar.v3.*" address: calendar.example.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth "apis": [ # A list of API interfaces exported by this service. Only the `name` field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files. - { # Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. + { # Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. New usages of this message as an alternative to ServiceDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. + "edition": "A String", # The source edition string, only valid when syntax is SYNTAX_EDITIONS. "methods": [ # The methods of this interface, in unspecified order. - { # Method represents a method of an API interface. + { # Method represents a method of an API interface. New usages of this message as an alternative to MethodDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. + "edition": "A String", # The source edition string, only valid when syntax is SYNTAX_EDITIONS. This field should be ignored, instead the edition should be inherited from Api. This is similar to Field and EnumValue. "name": "A String", # The simple name of this method. "options": [ # Any metadata attached to the method. - { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. + { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. "name": "A String", # The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. "value": { # The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -2258,7 +2269,7 @@

Method Details

"requestTypeUrl": "A String", # A URL of the input message type. "responseStreaming": True or False, # If true, the response is streamed. "responseTypeUrl": "A String", # The URL of the output message type. - "syntax": "A String", # The source syntax of this method. + "syntax": "A String", # The source syntax of this method. This field should be ignored, instead the syntax should be inherited from Api. This is similar to Field and EnumValue. }, ], "mixins": [ # Included interfaces. See Mixin. @@ -2269,7 +2280,7 @@

Method Details

], "name": "A String", # The fully qualified name of this interface, including package name followed by the interface's simple name. "options": [ # Any metadata attached to the interface. - { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. + { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. "name": "A String", # The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. "value": { # The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -2338,7 +2349,7 @@

Method Details

"overridesByRequestProtocol": { # The map between request protocol and the backend address. "a_key": # Object with schema name: BackendRule }, - "pathTranslation": "A String", + "pathTranslation": "A String", # no-lint "protocol": "A String", # The protocol used for sending a request to the backend. The supported values are "http/1.1" and "h2". The default value is inferred from the scheme in the address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this field to "h2" for improved performance. Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends. See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values. "selector": "A String", # Selects the methods to which this rule applies. Refer to selector for syntax details. }, @@ -2444,14 +2455,14 @@

Method Details

}, ], "enums": [ # A list of all enum types included in this API service. Enums referenced directly or indirectly by the `apis` are automatically included. Enums which are not referenced but shall be included should be listed here by name by the configuration author. Example: enums: - name: google.someapi.v1.SomeEnum - { # Enum type definition. + { # Enum type definition. New usages of this message as an alternative to EnumDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. "edition": "A String", # The source edition string, only valid when syntax is SYNTAX_EDITIONS. "enumvalue": [ # Enum value definitions. - { # Enum value definition. + { # Enum value definition. New usages of this message as an alternative to EnumValueDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. "name": "A String", # Enum value name. "number": 42, # Enum value number. "options": [ # Protocol buffer options. - { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. + { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. "name": "A String", # The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. "value": { # The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -2462,7 +2473,7 @@

Method Details

], "name": "A String", # Enum type name. "options": [ # Protocol buffer options. - { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. + { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. "name": "A String", # The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. "value": { # The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -2662,7 +2673,7 @@

Method Details

], }, }, - "renamedServices": { # Map of service names to renamed services. Keys are the package relative service names and values are the name to be used for the service client and call options. publishing: go_settings: renamed_services: Publisher: TopicAdmin + "renamedServices": { # Map of service names to renamed services. Keys are the package relative service names and values are the name to be used for the service client and call options. Example: publishing: go_settings: renamed_services: Publisher: TopicAdmin "a_key": "A String", }, }, @@ -2712,6 +2723,7 @@

Method Details

], }, }, + "libraryPackage": "A String", # The package name to use in Php. Clobbers the php_namespace option set in the protobuf. This should be used **only** by APIs who have already set the language_settings.php.package_name" field in gapic.yaml. API teams should use the protobuf php_namespace option where possible. Example of a YAML configuration:: publishing: library_settings: php_settings: library_package: Google\Cloud\PubSub\V1 }, "pythonSettings": { # Settings for Python client libraries. # Settings for Python client libraries. "common": { # Required information for every language. # Some settings. @@ -2836,10 +2848,10 @@

Method Details

], }, "systemTypes": [ # A list of all proto message types included in this API service. It serves similar purpose as [google.api.Service.types], except that these types are not needed by user-defined APIs. Therefore, they will not show up in the generated discovery doc. This field should only be used to define system APIs in ESF. - { # A protocol buffer message type. + { # A protocol buffer message type. New usages of this message as an alternative to DescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. "edition": "A String", # The source edition string, only valid when syntax is SYNTAX_EDITIONS. "fields": [ # The list of fields. - { # A single field of a message type. + { # A single field of a message type. New usages of this message as an alternative to FieldDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. "cardinality": "A String", # The field cardinality. "defaultValue": "A String", # The string value of the default value of this field. Proto2 syntax only. "jsonName": "A String", # The field JSON name. @@ -2848,7 +2860,7 @@

Method Details

"number": 42, # The field number. "oneofIndex": 42, # The index of the field type in `Type.oneofs`, for message or enumeration types. The first type has index 1; zero means the type is not in the list. "options": [ # The protocol buffer options. - { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. + { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. "name": "A String", # The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. "value": { # The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -2864,7 +2876,7 @@

Method Details

"A String", ], "options": [ # The protocol buffer options. - { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. + { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. "name": "A String", # The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. "value": { # The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -2879,10 +2891,10 @@

Method Details

], "title": "A String", # The product title for this service, it is the name displayed in Google Cloud Console. "types": [ # A list of all proto message types included in this API service. Types referenced directly or indirectly by the `apis` are automatically included. Messages which are not referenced but shall be included, such as types used by the `google.protobuf.Any` type, should be listed here by name by the configuration author. Example: types: - name: google.protobuf.Int32 - { # A protocol buffer message type. + { # A protocol buffer message type. New usages of this message as an alternative to DescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. "edition": "A String", # The source edition string, only valid when syntax is SYNTAX_EDITIONS. "fields": [ # The list of fields. - { # A single field of a message type. + { # A single field of a message type. New usages of this message as an alternative to FieldDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. "cardinality": "A String", # The field cardinality. "defaultValue": "A String", # The string value of the default value of this field. Proto2 syntax only. "jsonName": "A String", # The field JSON name. @@ -2891,7 +2903,7 @@

Method Details

"number": 42, # The field number. "oneofIndex": 42, # The index of the field type in `Type.oneofs`, for message or enumeration types. The first type has index 1; zero means the type is not in the list. "options": [ # The protocol buffer options. - { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. + { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. "name": "A String", # The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. "value": { # The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -2907,7 +2919,7 @@

Method Details

"A String", ], "options": [ # The protocol buffer options. - { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. + { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. "name": "A String", # The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. "value": { # The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. "a_key": "", # Properties of the object. Contains field @type with type URL. diff --git a/docs/dyn/servicemanagement_v1.services.html b/docs/dyn/servicemanagement_v1.services.html index 7bc55160bcc..5684bfcc73c 100644 --- a/docs/dyn/servicemanagement_v1.services.html +++ b/docs/dyn/servicemanagement_v1.services.html @@ -304,12 +304,14 @@

Method Details

{ # `Service` is the root object of Google API service configuration (service config). It describes the basic information about a logical service, such as the service name and the user-facing title, and delegates other aspects to sub-sections. Each sub-section is either a proto message or a repeated proto message that configures a specific aspect, such as auth. For more information, see each proto message definition. Example: type: google.api.Service name: calendar.googleapis.com title: Google Calendar API apis: - name: google.calendar.v3.Calendar visibility: rules: - selector: "google.calendar.v3.*" restriction: PREVIEW backend: rules: - selector: "google.calendar.v3.*" address: calendar.example.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth "apis": [ # A list of API interfaces exported by this service. Only the `name` field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files. - { # Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. + { # Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. New usages of this message as an alternative to ServiceDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. + "edition": "A String", # The source edition string, only valid when syntax is SYNTAX_EDITIONS. "methods": [ # The methods of this interface, in unspecified order. - { # Method represents a method of an API interface. + { # Method represents a method of an API interface. New usages of this message as an alternative to MethodDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. + "edition": "A String", # The source edition string, only valid when syntax is SYNTAX_EDITIONS. This field should be ignored, instead the edition should be inherited from Api. This is similar to Field and EnumValue. "name": "A String", # The simple name of this method. "options": [ # Any metadata attached to the method. - { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. + { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. "name": "A String", # The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. "value": { # The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -320,7 +322,7 @@

Method Details

"requestTypeUrl": "A String", # A URL of the input message type. "responseStreaming": True or False, # If true, the response is streamed. "responseTypeUrl": "A String", # The URL of the output message type. - "syntax": "A String", # The source syntax of this method. + "syntax": "A String", # The source syntax of this method. This field should be ignored, instead the syntax should be inherited from Api. This is similar to Field and EnumValue. }, ], "mixins": [ # Included interfaces. See Mixin. @@ -331,7 +333,7 @@

Method Details

], "name": "A String", # The fully qualified name of this interface, including package name followed by the interface's simple name. "options": [ # Any metadata attached to the interface. - { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. + { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. "name": "A String", # The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. "value": { # The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -400,7 +402,7 @@

Method Details

"overridesByRequestProtocol": { # The map between request protocol and the backend address. "a_key": # Object with schema name: BackendRule }, - "pathTranslation": "A String", + "pathTranslation": "A String", # no-lint "protocol": "A String", # The protocol used for sending a request to the backend. The supported values are "http/1.1" and "h2". The default value is inferred from the scheme in the address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this field to "h2" for improved performance. Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends. See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values. "selector": "A String", # Selects the methods to which this rule applies. Refer to selector for syntax details. }, @@ -506,14 +508,14 @@

Method Details

}, ], "enums": [ # A list of all enum types included in this API service. Enums referenced directly or indirectly by the `apis` are automatically included. Enums which are not referenced but shall be included should be listed here by name by the configuration author. Example: enums: - name: google.someapi.v1.SomeEnum - { # Enum type definition. + { # Enum type definition. New usages of this message as an alternative to EnumDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. "edition": "A String", # The source edition string, only valid when syntax is SYNTAX_EDITIONS. "enumvalue": [ # Enum value definitions. - { # Enum value definition. + { # Enum value definition. New usages of this message as an alternative to EnumValueDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. "name": "A String", # Enum value name. "number": 42, # Enum value number. "options": [ # Protocol buffer options. - { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. + { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. "name": "A String", # The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. "value": { # The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -524,7 +526,7 @@

Method Details

], "name": "A String", # Enum type name. "options": [ # Protocol buffer options. - { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. + { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. "name": "A String", # The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. "value": { # The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -724,7 +726,7 @@

Method Details

], }, }, - "renamedServices": { # Map of service names to renamed services. Keys are the package relative service names and values are the name to be used for the service client and call options. publishing: go_settings: renamed_services: Publisher: TopicAdmin + "renamedServices": { # Map of service names to renamed services. Keys are the package relative service names and values are the name to be used for the service client and call options. Example: publishing: go_settings: renamed_services: Publisher: TopicAdmin "a_key": "A String", }, }, @@ -774,6 +776,7 @@

Method Details

], }, }, + "libraryPackage": "A String", # The package name to use in Php. Clobbers the php_namespace option set in the protobuf. This should be used **only** by APIs who have already set the language_settings.php.package_name" field in gapic.yaml. API teams should use the protobuf php_namespace option where possible. Example of a YAML configuration:: publishing: library_settings: php_settings: library_package: Google\Cloud\PubSub\V1 }, "pythonSettings": { # Settings for Python client libraries. # Settings for Python client libraries. "common": { # Required information for every language. # Some settings. @@ -898,10 +901,10 @@

Method Details

], }, "systemTypes": [ # A list of all proto message types included in this API service. It serves similar purpose as [google.api.Service.types], except that these types are not needed by user-defined APIs. Therefore, they will not show up in the generated discovery doc. This field should only be used to define system APIs in ESF. - { # A protocol buffer message type. + { # A protocol buffer message type. New usages of this message as an alternative to DescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. "edition": "A String", # The source edition string, only valid when syntax is SYNTAX_EDITIONS. "fields": [ # The list of fields. - { # A single field of a message type. + { # A single field of a message type. New usages of this message as an alternative to FieldDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. "cardinality": "A String", # The field cardinality. "defaultValue": "A String", # The string value of the default value of this field. Proto2 syntax only. "jsonName": "A String", # The field JSON name. @@ -910,7 +913,7 @@

Method Details

"number": 42, # The field number. "oneofIndex": 42, # The index of the field type in `Type.oneofs`, for message or enumeration types. The first type has index 1; zero means the type is not in the list. "options": [ # The protocol buffer options. - { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. + { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. "name": "A String", # The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. "value": { # The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -926,7 +929,7 @@

Method Details

"A String", ], "options": [ # The protocol buffer options. - { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. + { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. "name": "A String", # The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. "value": { # The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -941,10 +944,10 @@

Method Details

], "title": "A String", # The product title for this service, it is the name displayed in Google Cloud Console. "types": [ # A list of all proto message types included in this API service. Types referenced directly or indirectly by the `apis` are automatically included. Messages which are not referenced but shall be included, such as types used by the `google.protobuf.Any` type, should be listed here by name by the configuration author. Example: types: - name: google.protobuf.Int32 - { # A protocol buffer message type. + { # A protocol buffer message type. New usages of this message as an alternative to DescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. "edition": "A String", # The source edition string, only valid when syntax is SYNTAX_EDITIONS. "fields": [ # The list of fields. - { # A single field of a message type. + { # A single field of a message type. New usages of this message as an alternative to FieldDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. "cardinality": "A String", # The field cardinality. "defaultValue": "A String", # The string value of the default value of this field. Proto2 syntax only. "jsonName": "A String", # The field JSON name. @@ -953,7 +956,7 @@

Method Details

"number": 42, # The field number. "oneofIndex": 42, # The index of the field type in `Type.oneofs`, for message or enumeration types. The first type has index 1; zero means the type is not in the list. "options": [ # The protocol buffer options. - { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. + { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. "name": "A String", # The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. "value": { # The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -969,7 +972,7 @@

Method Details

"A String", ], "options": [ # The protocol buffer options. - { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. + { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. "name": "A String", # The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. "value": { # The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. "a_key": "", # Properties of the object. Contains field @type with type URL. diff --git a/docs/dyn/servicemanagement_v1.services.rollouts.html b/docs/dyn/servicemanagement_v1.services.rollouts.html index 6842e643867..1f0a78bfa18 100644 --- a/docs/dyn/servicemanagement_v1.services.rollouts.html +++ b/docs/dyn/servicemanagement_v1.services.rollouts.html @@ -117,7 +117,6 @@

Method Details

"a_key": 3.14, }, }, - "universe": "A String", # The TPC universe which the rollout will be rolled out to. } x__xgafv: string, V1 error format. @@ -177,7 +176,6 @@

Method Details

"a_key": 3.14, }, }, - "universe": "A String", # The TPC universe which the rollout will be rolled out to. } @@ -214,7 +212,6 @@

Method Details

"a_key": 3.14, }, }, - "universe": "A String", # The TPC universe which the rollout will be rolled out to. }, ], } diff --git a/googleapiclient/discovery_cache/documents/servicemanagement.v1.json b/googleapiclient/discovery_cache/documents/servicemanagement.v1.json index 80ff3407a92..a79cfeaf2d5 100644 --- a/googleapiclient/discovery_cache/documents/servicemanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/servicemanagement.v1.json @@ -830,7 +830,7 @@ } } }, -"revision": "20250601", +"revision": "20250812", "rootUrl": "https://servicemanagement.googleapis.com/", "schemas": { "Advice": { @@ -845,9 +845,13 @@ "type": "object" }, "Api": { -"description": "Api is a light-weight descriptor for an API Interface. Interfaces are also described as \"protocol buffer services\" in some contexts, such as by the \"service\" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as \"APIs\" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology.", +"description": "Api is a light-weight descriptor for an API Interface. Interfaces are also described as \"protocol buffer services\" in some contexts, such as by the \"service\" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as \"APIs\" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. New usages of this message as an alternative to ServiceDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "Api", "properties": { +"edition": { +"description": "The source edition string, only valid when syntax is SYNTAX_EDITIONS.", +"type": "string" +}, "methods": { "description": "The methods of this interface, in unspecified order.", "items": { @@ -1119,6 +1123,7 @@ "type": "object" }, "pathTranslation": { +"description": "no-lint", "enum": [ "PATH_TRANSLATION_UNSPECIFIED", "CONSTANT_ADDRESS", @@ -1832,7 +1837,7 @@ "type": "object" }, "Enum": { -"description": "Enum type definition.", +"description": "Enum type definition. New usages of this message as an alternative to EnumDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "Enum", "properties": { "edition": { @@ -1879,7 +1884,7 @@ "type": "object" }, "EnumValue": { -"description": "Enum value definition.", +"description": "Enum value definition. New usages of this message as an alternative to EnumValueDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "EnumValue", "properties": { "name": { @@ -1944,7 +1949,7 @@ "type": "object" }, "Field": { -"description": "A single field of a message type.", +"description": "A single field of a message type. New usages of this message as an alternative to FieldDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "Field", "properties": { "cardinality": { @@ -2170,7 +2175,7 @@ "additionalProperties": { "type": "string" }, -"description": "Map of service names to renamed services. Keys are the package relative service names and values are the name to be used for the service client and call options. publishing: go_settings: renamed_services: Publisher: TopicAdmin", +"description": "Map of service names to renamed services. Keys are the package relative service names and values are the name to be used for the service client and call options. Example: publishing: go_settings: renamed_services: Publisher: TopicAdmin", "type": "object" } }, @@ -2498,9 +2503,14 @@ "type": "object" }, "Method": { -"description": "Method represents a method of an API interface.", +"description": "Method represents a method of an API interface. New usages of this message as an alternative to MethodDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "Method", "properties": { +"edition": { +"deprecated": true, +"description": "The source edition string, only valid when syntax is SYNTAX_EDITIONS. This field should be ignored, instead the edition should be inherited from Api. This is similar to Field and EnumValue.", +"type": "string" +}, "name": { "description": "The simple name of this method.", "type": "string" @@ -2529,7 +2539,8 @@ "type": "string" }, "syntax": { -"description": "The source syntax of this method.", +"deprecated": true, +"description": "The source syntax of this method. This field should be ignored, instead the syntax should be inherited from Api. This is similar to Field and EnumValue.", "enum": [ "SYNTAX_PROTO2", "SYNTAX_PROTO3", @@ -2988,7 +2999,7 @@ "type": "object" }, "Option": { -"description": "A protocol buffer option, which can be attached to a message, field, enumeration, etc.", +"description": "A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged.", "id": "Option", "properties": { "name": { @@ -3035,6 +3046,10 @@ "common": { "$ref": "CommonLanguageSettings", "description": "Some settings." +}, +"libraryPackage": { +"description": "The package name to use in Php. Clobbers the php_namespace option set in the protobuf. This should be used **only** by APIs who have already set the language_settings.php.package_name\" field in gapic.yaml. API teams should use the protobuf php_namespace option where possible. Example of a YAML configuration:: publishing: library_settings: php_settings: library_package: Google\\Cloud\\PubSub\\V1", +"type": "string" } }, "type": "object" @@ -3305,10 +3320,6 @@ "trafficPercentStrategy": { "$ref": "TrafficPercentStrategy", "description": "Google Service Control selects service configurations based on traffic percentage." -}, -"universe": { -"description": "The TPC universe which the rollout will be rolled out to.", -"type": "string" } }, "type": "object" @@ -3584,7 +3595,7 @@ "CANCELLED" ], "enumDescriptions": [ -"Unspecifed code.", +"Unspecified code.", "The operation or step has completed without errors.", "The operation or step has not started yet.", "The operation or step is in progress.", @@ -3717,7 +3728,7 @@ "type": "object" }, "Type": { -"description": "A protocol buffer message type.", +"description": "A protocol buffer message type. New usages of this message as an alternative to DescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "Type", "properties": { "edition": { From 781371b027ca978e2c38864f7d53f645306d21e9 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 30 Sep 2025 07:09:37 +0000 Subject: [PATCH 36/42] feat(serviceusage): update the api #### serviceusage:v1 The following keys were added: - schemas.Api.properties.edition.type (Total Keys: 1) - schemas.ContentSecurity (Total Keys: 7) - schemas.GoogleApiServiceusageV2betaImpact.properties.missingDependency (Total Keys: 2) - schemas.McpEnableRule (Total Keys: 4) - schemas.McpPolicy (Total Keys: 13) - schemas.McpService (Total Keys: 3) - schemas.Method.properties.edition (Total Keys: 2) - schemas.Method.properties.syntax.deprecated (Total Keys: 1) - schemas.UpdateMcpPolicyMetadata (Total Keys: 2) #### serviceusage:v1beta1 The following keys were added: - schemas.Api.properties.edition.type (Total Keys: 1) - schemas.ContentSecurity (Total Keys: 7) - schemas.GoogleApiServiceusageV2betaImpact.properties.missingDependency (Total Keys: 2) - schemas.McpEnableRule (Total Keys: 4) - schemas.McpPolicy (Total Keys: 13) - schemas.McpService (Total Keys: 3) - schemas.Method.properties.edition (Total Keys: 2) - schemas.Method.properties.syntax.deprecated (Total Keys: 1) - schemas.UpdateMcpPolicyMetadata (Total Keys: 2) --- docs/dyn/serviceusage_v1.services.html | 36 +++-- docs/dyn/serviceusage_v1beta1.services.html | 24 ++-- .../documents/serviceusage.v1.json | 134 ++++++++++++++++-- .../documents/serviceusage.v1beta1.json | 134 ++++++++++++++++-- 4 files changed, 279 insertions(+), 49 deletions(-) diff --git a/docs/dyn/serviceusage_v1.services.html b/docs/dyn/serviceusage_v1.services.html index 2935d487c77..add9ef6d2b8 100644 --- a/docs/dyn/serviceusage_v1.services.html +++ b/docs/dyn/serviceusage_v1.services.html @@ -163,12 +163,14 @@

Method Details

{ # A service that is available for use by the consumer. "config": { # The configuration of the service. # The service configuration of the available service. Some fields may be filtered out of the configuration in responses to the `ListServices` method. These fields are present only in responses to the `GetService` method. "apis": [ # A list of API interfaces exported by this service. Contains only the names, versions, and method names of the interfaces. - { # Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. + { # Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. New usages of this message as an alternative to ServiceDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. + "edition": "A String", # The source edition string, only valid when syntax is SYNTAX_EDITIONS. "methods": [ # The methods of this interface, in unspecified order. - { # Method represents a method of an API interface. + { # Method represents a method of an API interface. New usages of this message as an alternative to MethodDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. + "edition": "A String", # The source edition string, only valid when syntax is SYNTAX_EDITIONS. This field should be ignored, instead the edition should be inherited from Api. This is similar to Field and EnumValue. "name": "A String", # The simple name of this method. "options": [ # Any metadata attached to the method. - { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. + { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. "name": "A String", # The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. "value": { # The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -179,7 +181,7 @@

Method Details

"requestTypeUrl": "A String", # A URL of the input message type. "responseStreaming": True or False, # If true, the response is streamed. "responseTypeUrl": "A String", # The URL of the output message type. - "syntax": "A String", # The source syntax of this method. + "syntax": "A String", # The source syntax of this method. This field should be ignored, instead the syntax should be inherited from Api. This is similar to Field and EnumValue. }, ], "mixins": [ # Included interfaces. See Mixin. @@ -190,7 +192,7 @@

Method Details

], "name": "A String", # The fully qualified name of this interface, including package name followed by the interface's simple name. "options": [ # Any metadata attached to the interface. - { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. + { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. "name": "A String", # The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. "value": { # The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -471,12 +473,14 @@

Method Details

{ # A service that is available for use by the consumer. "config": { # The configuration of the service. # The service configuration of the available service. Some fields may be filtered out of the configuration in responses to the `ListServices` method. These fields are present only in responses to the `GetService` method. "apis": [ # A list of API interfaces exported by this service. Contains only the names, versions, and method names of the interfaces. - { # Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. + { # Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. New usages of this message as an alternative to ServiceDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. + "edition": "A String", # The source edition string, only valid when syntax is SYNTAX_EDITIONS. "methods": [ # The methods of this interface, in unspecified order. - { # Method represents a method of an API interface. + { # Method represents a method of an API interface. New usages of this message as an alternative to MethodDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. + "edition": "A String", # The source edition string, only valid when syntax is SYNTAX_EDITIONS. This field should be ignored, instead the edition should be inherited from Api. This is similar to Field and EnumValue. "name": "A String", # The simple name of this method. "options": [ # Any metadata attached to the method. - { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. + { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. "name": "A String", # The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. "value": { # The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -487,7 +491,7 @@

Method Details

"requestTypeUrl": "A String", # A URL of the input message type. "responseStreaming": True or False, # If true, the response is streamed. "responseTypeUrl": "A String", # The URL of the output message type. - "syntax": "A String", # The source syntax of this method. + "syntax": "A String", # The source syntax of this method. This field should be ignored, instead the syntax should be inherited from Api. This is similar to Field and EnumValue. }, ], "mixins": [ # Included interfaces. See Mixin. @@ -498,7 +502,7 @@

Method Details

], "name": "A String", # The fully qualified name of this interface, including package name followed by the interface's simple name. "options": [ # Any metadata attached to the interface. - { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. + { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. "name": "A String", # The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. "value": { # The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -694,12 +698,14 @@

Method Details

{ # A service that is available for use by the consumer. "config": { # The configuration of the service. # The service configuration of the available service. Some fields may be filtered out of the configuration in responses to the `ListServices` method. These fields are present only in responses to the `GetService` method. "apis": [ # A list of API interfaces exported by this service. Contains only the names, versions, and method names of the interfaces. - { # Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. + { # Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. New usages of this message as an alternative to ServiceDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. + "edition": "A String", # The source edition string, only valid when syntax is SYNTAX_EDITIONS. "methods": [ # The methods of this interface, in unspecified order. - { # Method represents a method of an API interface. + { # Method represents a method of an API interface. New usages of this message as an alternative to MethodDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. + "edition": "A String", # The source edition string, only valid when syntax is SYNTAX_EDITIONS. This field should be ignored, instead the edition should be inherited from Api. This is similar to Field and EnumValue. "name": "A String", # The simple name of this method. "options": [ # Any metadata attached to the method. - { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. + { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. "name": "A String", # The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. "value": { # The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -710,7 +716,7 @@

Method Details

"requestTypeUrl": "A String", # A URL of the input message type. "responseStreaming": True or False, # If true, the response is streamed. "responseTypeUrl": "A String", # The URL of the output message type. - "syntax": "A String", # The source syntax of this method. + "syntax": "A String", # The source syntax of this method. This field should be ignored, instead the syntax should be inherited from Api. This is similar to Field and EnumValue. }, ], "mixins": [ # Included interfaces. See Mixin. @@ -721,7 +727,7 @@

Method Details

], "name": "A String", # The fully qualified name of this interface, including package name followed by the interface's simple name. "options": [ # Any metadata attached to the interface. - { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. + { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. "name": "A String", # The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. "value": { # The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. "a_key": "", # Properties of the object. Contains field @type with type URL. diff --git a/docs/dyn/serviceusage_v1beta1.services.html b/docs/dyn/serviceusage_v1beta1.services.html index a80675f9a35..b423ae0a2a6 100644 --- a/docs/dyn/serviceusage_v1beta1.services.html +++ b/docs/dyn/serviceusage_v1beta1.services.html @@ -287,12 +287,14 @@

Method Details

{ # A service that is available for use by the consumer. "config": { # The configuration of the service. # The service configuration of the available service. Some fields may be filtered out of the configuration in responses to the `ListServices` method. These fields are present only in responses to the `GetService` method. "apis": [ # A list of API interfaces exported by this service. Contains only the names, versions, and method names of the interfaces. - { # Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. + { # Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. New usages of this message as an alternative to ServiceDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. + "edition": "A String", # The source edition string, only valid when syntax is SYNTAX_EDITIONS. "methods": [ # The methods of this interface, in unspecified order. - { # Method represents a method of an API interface. + { # Method represents a method of an API interface. New usages of this message as an alternative to MethodDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. + "edition": "A String", # The source edition string, only valid when syntax is SYNTAX_EDITIONS. This field should be ignored, instead the edition should be inherited from Api. This is similar to Field and EnumValue. "name": "A String", # The simple name of this method. "options": [ # Any metadata attached to the method. - { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. + { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. "name": "A String", # The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. "value": { # The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -303,7 +305,7 @@

Method Details

"requestTypeUrl": "A String", # A URL of the input message type. "responseStreaming": True or False, # If true, the response is streamed. "responseTypeUrl": "A String", # The URL of the output message type. - "syntax": "A String", # The source syntax of this method. + "syntax": "A String", # The source syntax of this method. This field should be ignored, instead the syntax should be inherited from Api. This is similar to Field and EnumValue. }, ], "mixins": [ # Included interfaces. See Mixin. @@ -314,7 +316,7 @@

Method Details

], "name": "A String", # The fully qualified name of this interface, including package name followed by the interface's simple name. "options": [ # Any metadata attached to the interface. - { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. + { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. "name": "A String", # The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. "value": { # The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -510,12 +512,14 @@

Method Details

{ # A service that is available for use by the consumer. "config": { # The configuration of the service. # The service configuration of the available service. Some fields may be filtered out of the configuration in responses to the `ListServices` method. These fields are present only in responses to the `GetService` method. "apis": [ # A list of API interfaces exported by this service. Contains only the names, versions, and method names of the interfaces. - { # Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. + { # Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. New usages of this message as an alternative to ServiceDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. + "edition": "A String", # The source edition string, only valid when syntax is SYNTAX_EDITIONS. "methods": [ # The methods of this interface, in unspecified order. - { # Method represents a method of an API interface. + { # Method represents a method of an API interface. New usages of this message as an alternative to MethodDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information. + "edition": "A String", # The source edition string, only valid when syntax is SYNTAX_EDITIONS. This field should be ignored, instead the edition should be inherited from Api. This is similar to Field and EnumValue. "name": "A String", # The simple name of this method. "options": [ # Any metadata attached to the method. - { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. + { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. "name": "A String", # The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. "value": { # The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -526,7 +530,7 @@

Method Details

"requestTypeUrl": "A String", # A URL of the input message type. "responseStreaming": True or False, # If true, the response is streamed. "responseTypeUrl": "A String", # The URL of the output message type. - "syntax": "A String", # The source syntax of this method. + "syntax": "A String", # The source syntax of this method. This field should be ignored, instead the syntax should be inherited from Api. This is similar to Field and EnumValue. }, ], "mixins": [ # Included interfaces. See Mixin. @@ -537,7 +541,7 @@

Method Details

], "name": "A String", # The fully qualified name of this interface, including package name followed by the interface's simple name. "options": [ # Any metadata attached to the interface. - { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. + { # A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged. "name": "A String", # The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the fully-qualified name. For example, `"google.api.http"`. "value": { # The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type. "a_key": "", # Properties of the object. Contains field @type with type URL. diff --git a/googleapiclient/discovery_cache/documents/serviceusage.v1.json b/googleapiclient/discovery_cache/documents/serviceusage.v1.json index b3c50794101..608e0c58406 100644 --- a/googleapiclient/discovery_cache/documents/serviceusage.v1.json +++ b/googleapiclient/discovery_cache/documents/serviceusage.v1.json @@ -426,7 +426,7 @@ } } }, -"revision": "20250619", +"revision": "20250919", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AddEnableRulesMetadata": { @@ -568,9 +568,13 @@ "type": "object" }, "Api": { -"description": "Api is a light-weight descriptor for an API Interface. Interfaces are also described as \"protocol buffer services\" in some contexts, such as by the \"service\" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as \"APIs\" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology.", +"description": "Api is a light-weight descriptor for an API Interface. Interfaces are also described as \"protocol buffer services\" in some contexts, such as by the \"service\" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as \"APIs\" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. New usages of this message as an alternative to ServiceDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "Api", "properties": { +"edition": { +"description": "The source edition string, only valid when syntax is SYNTAX_EDITIONS.", +"type": "string" +}, "methods": { "description": "The methods of this interface, in unspecified order.", "items": { @@ -794,6 +798,7 @@ "type": "object" }, "pathTranslation": { +"description": "no-lint", "enum": [ "PATH_TRANSLATION_UNSPECIFIED", "CONSTANT_ADDRESS", @@ -1166,6 +1171,31 @@ }, "type": "object" }, +"ContentSecurity": { +"description": "ContentSecurity defines the content security related fields of a MCP policy.", +"id": "ContentSecurity", +"properties": { +"contentSecurityProviders": { +"description": "List of content security providers that are enabled for content scanning.", +"items": { +"$ref": "ContentSecurityProvider" +}, +"type": "array" +} +}, +"type": "object" +}, +"ContentSecurityProvider": { +"description": "ContentSecurityProvider contains the name of content security provider.", +"id": "ContentSecurityProvider", +"properties": { +"name": { +"description": "Name of security service for content scanning, such as Google Cloud Model Armor or supported third-party ISV solutions. If it is Google 1P service, the name should be prefixed with `services/`. If it is a 3P service, the format needs to be documented. The currently supported values are: - `services/modelarmor.googleapis.com` for Google Cloud Model Armor.", +"type": "string" +} +}, +"type": "object" +}, "Context": { "description": "`Context` defines which contexts an API requests. Example: context: rules: - selector: \"*\" requested: - google.rpc.context.ProjectContext - google.rpc.context.OriginContext The above specifies that all methods in the API request `google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. Available context types are defined in package `google.rpc.context`. This also provides mechanism to allowlist any protobuf message extension that can be sent in grpc metadata using \u201cx-goog-ext--bin\u201d and \u201cx-goog-ext--jspb\u201d format. For example, list any service specific protobuf types that can appear in grpc metadata as follows in your yaml file: Example: context: rules: - selector: \"google.example.library.v1.LibraryService.CreateBook\" allowed_request_extensions: - google.foo.v1.NewExtension allowed_response_extensions: - google.foo.v1.NewExtension You can also specify extension ID instead of fully qualified extension name here.", "id": "Context", @@ -1575,7 +1605,7 @@ "type": "object" }, "Enum": { -"description": "Enum type definition.", +"description": "Enum type definition. New usages of this message as an alternative to EnumDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "Enum", "properties": { "edition": { @@ -1622,7 +1652,7 @@ "type": "object" }, "EnumValue": { -"description": "Enum value definition.", +"description": "Enum value definition. New usages of this message as an alternative to EnumValueDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "EnumValue", "properties": { "name": { @@ -1664,7 +1694,7 @@ "type": "object" }, "Field": { -"description": "A single field of a message type.", +"description": "A single field of a message type. New usages of this message as an alternative to FieldDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "Field", "properties": { "cardinality": { @@ -1829,7 +1859,7 @@ "additionalProperties": { "type": "string" }, -"description": "Map of service names to renamed services. Keys are the package relative service names and values are the name to be used for the service client and call options. publishing: go_settings: renamed_services: Publisher: TopicAdmin", +"description": "Map of service names to renamed services. Keys are the package relative service names and values are the name to be used for the service client and call options. Example: publishing: go_settings: renamed_services: Publisher: TopicAdmin", "type": "object" } }, @@ -2292,8 +2322,7 @@ "type": "array" }, "etag": { -"description": "Output only. An opaque tag indicating the current version of the policy, used for concurrency control.", -"readOnly": true, +"description": "An opaque tag indicating the current version of the policy, used for concurrency control.", "type": "string" }, "name": { @@ -2345,6 +2374,11 @@ ], "readOnly": true, "type": "string" +}, +"missingDependency": { +"description": "Output only. This field will be populated only for the `DEPENDENCY_MISSING_DEPENDENCIES` impact type. Example: `services/compute.googleapis.com`. Impact.detail will be in format : `missing service dependency: {missing_dependency}.`", +"readOnly": true, +"type": "string" } }, "type": "object" @@ -2716,10 +2750,79 @@ }, "type": "object" }, +"McpEnableRule": { +"description": "McpEnableRule contains MCP enablement related rules.", +"id": "McpEnableRule", +"properties": { +"mcpServices": { +"description": "List of enabled MCP services.", +"items": { +"$ref": "McpService" +}, +"type": "array" +} +}, +"type": "object" +}, +"McpPolicy": { +"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", +"readOnly": true, +"type": "string" +}, +"etag": { +"description": "An opaque tag indicating the current version of the policy, used for concurrency control.", +"type": "string" +}, +"mcpEnableRules": { +"description": "McpEnableRules contains MCP enablement related rules.", +"items": { +"$ref": "McpEnableRule" +}, +"type": "array" +}, +"name": { +"description": "Output only. The resource name of the policy. Only the `default` policy is supported. We allow the following formats: `projects/{PROJECT_NUMBER}/mcpPolicies/default`, `projects/{PROJECT_ID}/mcpPolicies/default`, `folders/{FOLDER_ID}/mcpPolicies/default`, `organizations/{ORG_ID}/mcpPolicies/default`.", +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. The time the policy was last updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"McpService": { +"description": "McpService contains the service names that are enabled for MCP.", +"id": "McpService", +"properties": { +"service": { +"description": "The names of the services that are enabled for MCP. Example: `services/library-example.googleapis.com`", +"type": "string" +} +}, +"type": "object" +}, "Method": { -"description": "Method represents a method of an API interface.", +"description": "Method represents a method of an API interface. New usages of this message as an alternative to MethodDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "Method", "properties": { +"edition": { +"deprecated": true, +"description": "The source edition string, only valid when syntax is SYNTAX_EDITIONS. This field should be ignored, instead the edition should be inherited from Api. This is similar to Field and EnumValue.", +"type": "string" +}, "name": { "description": "The simple name of this method.", "type": "string" @@ -2748,7 +2851,8 @@ "type": "string" }, "syntax": { -"description": "The source syntax of this method.", +"deprecated": true, +"description": "The source syntax of this method. This field should be ignored, instead the syntax should be inherited from Api. This is similar to Field and EnumValue.", "enum": [ "SYNTAX_PROTO2", "SYNTAX_PROTO3", @@ -3175,7 +3279,7 @@ "type": "object" }, "Option": { -"description": "A protocol buffer option, which can be attached to a message, field, enumeration, etc.", +"description": "A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged.", "id": "Option", "properties": { "name": { @@ -3612,7 +3716,7 @@ "type": "object" }, "Type": { -"description": "A protocol buffer message type.", +"description": "A protocol buffer message type. New usages of this message as an alternative to DescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "Type", "properties": { "edition": { @@ -3677,6 +3781,12 @@ "properties": {}, "type": "object" }, +"UpdateMcpPolicyMetadata": { +"description": "Metadata for the `UpdateMcpPolicy` method.", +"id": "UpdateMcpPolicyMetadata", +"properties": {}, +"type": "object" +}, "Usage": { "description": "Configuration controlling usage of a service.", "id": "Usage", diff --git a/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json b/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json index 8ebdd8e5a7f..3f5fd5f70a7 100644 --- a/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json @@ -964,7 +964,7 @@ } } }, -"revision": "20250619", +"revision": "20250919", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AddEnableRulesMetadata": { @@ -1106,9 +1106,13 @@ "type": "object" }, "Api": { -"description": "Api is a light-weight descriptor for an API Interface. Interfaces are also described as \"protocol buffer services\" in some contexts, such as by the \"service\" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as \"APIs\" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology.", +"description": "Api is a light-weight descriptor for an API Interface. Interfaces are also described as \"protocol buffer services\" in some contexts, such as by the \"service\" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as \"APIs\" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. New usages of this message as an alternative to ServiceDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "Api", "properties": { +"edition": { +"description": "The source edition string, only valid when syntax is SYNTAX_EDITIONS.", +"type": "string" +}, "methods": { "description": "The methods of this interface, in unspecified order.", "items": { @@ -1332,6 +1336,7 @@ "type": "object" }, "pathTranslation": { +"description": "no-lint", "enum": [ "PATH_TRANSLATION_UNSPECIFIED", "CONSTANT_ADDRESS", @@ -1762,6 +1767,31 @@ }, "type": "object" }, +"ContentSecurity": { +"description": "ContentSecurity defines the content security related fields of a MCP policy.", +"id": "ContentSecurity", +"properties": { +"contentSecurityProviders": { +"description": "List of content security providers that are enabled for content scanning.", +"items": { +"$ref": "ContentSecurityProvider" +}, +"type": "array" +} +}, +"type": "object" +}, +"ContentSecurityProvider": { +"description": "ContentSecurityProvider contains the name of content security provider.", +"id": "ContentSecurityProvider", +"properties": { +"name": { +"description": "Name of security service for content scanning, such as Google Cloud Model Armor or supported third-party ISV solutions. If it is Google 1P service, the name should be prefixed with `services/`. If it is a 3P service, the format needs to be documented. The currently supported values are: - `services/modelarmor.googleapis.com` for Google Cloud Model Armor.", +"type": "string" +} +}, +"type": "object" +}, "Context": { "description": "`Context` defines which contexts an API requests. Example: context: rules: - selector: \"*\" requested: - google.rpc.context.ProjectContext - google.rpc.context.OriginContext The above specifies that all methods in the API request `google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. Available context types are defined in package `google.rpc.context`. This also provides mechanism to allowlist any protobuf message extension that can be sent in grpc metadata using \u201cx-goog-ext--bin\u201d and \u201cx-goog-ext--jspb\u201d format. For example, list any service specific protobuf types that can appear in grpc metadata as follows in your yaml file: Example: context: rules: - selector: \"google.example.library.v1.LibraryService.CreateBook\" allowed_request_extensions: - google.foo.v1.NewExtension allowed_response_extensions: - google.foo.v1.NewExtension You can also specify extension ID instead of fully qualified extension name here.", "id": "Context", @@ -2152,7 +2182,7 @@ "type": "object" }, "Enum": { -"description": "Enum type definition.", +"description": "Enum type definition. New usages of this message as an alternative to EnumDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "Enum", "properties": { "edition": { @@ -2199,7 +2229,7 @@ "type": "object" }, "EnumValue": { -"description": "Enum value definition.", +"description": "Enum value definition. New usages of this message as an alternative to EnumValueDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "EnumValue", "properties": { "name": { @@ -2241,7 +2271,7 @@ "type": "object" }, "Field": { -"description": "A single field of a message type.", +"description": "A single field of a message type. New usages of this message as an alternative to FieldDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "Field", "properties": { "cardinality": { @@ -2406,7 +2436,7 @@ "additionalProperties": { "type": "string" }, -"description": "Map of service names to renamed services. Keys are the package relative service names and values are the name to be used for the service client and call options. publishing: go_settings: renamed_services: Publisher: TopicAdmin", +"description": "Map of service names to renamed services. Keys are the package relative service names and values are the name to be used for the service client and call options. Example: publishing: go_settings: renamed_services: Publisher: TopicAdmin", "type": "object" } }, @@ -2869,8 +2899,7 @@ "type": "array" }, "etag": { -"description": "Output only. An opaque tag indicating the current version of the policy, used for concurrency control.", -"readOnly": true, +"description": "An opaque tag indicating the current version of the policy, used for concurrency control.", "type": "string" }, "name": { @@ -2922,6 +2951,11 @@ ], "readOnly": true, "type": "string" +}, +"missingDependency": { +"description": "Output only. This field will be populated only for the `DEPENDENCY_MISSING_DEPENDENCIES` impact type. Example: `services/compute.googleapis.com`. Impact.detail will be in format : `missing service dependency: {missing_dependency}.`", +"readOnly": true, +"type": "string" } }, "type": "object" @@ -3411,10 +3445,79 @@ }, "type": "object" }, +"McpEnableRule": { +"description": "McpEnableRule contains MCP enablement related rules.", +"id": "McpEnableRule", +"properties": { +"mcpServices": { +"description": "List of enabled MCP services.", +"items": { +"$ref": "McpService" +}, +"type": "array" +} +}, +"type": "object" +}, +"McpPolicy": { +"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", +"readOnly": true, +"type": "string" +}, +"etag": { +"description": "An opaque tag indicating the current version of the policy, used for concurrency control.", +"type": "string" +}, +"mcpEnableRules": { +"description": "McpEnableRules contains MCP enablement related rules.", +"items": { +"$ref": "McpEnableRule" +}, +"type": "array" +}, +"name": { +"description": "Output only. The resource name of the policy. Only the `default` policy is supported. We allow the following formats: `projects/{PROJECT_NUMBER}/mcpPolicies/default`, `projects/{PROJECT_ID}/mcpPolicies/default`, `folders/{FOLDER_ID}/mcpPolicies/default`, `organizations/{ORG_ID}/mcpPolicies/default`.", +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. The time the policy was last updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"McpService": { +"description": "McpService contains the service names that are enabled for MCP.", +"id": "McpService", +"properties": { +"service": { +"description": "The names of the services that are enabled for MCP. Example: `services/library-example.googleapis.com`", +"type": "string" +} +}, +"type": "object" +}, "Method": { -"description": "Method represents a method of an API interface.", +"description": "Method represents a method of an API interface. New usages of this message as an alternative to MethodDescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "Method", "properties": { +"edition": { +"deprecated": true, +"description": "The source edition string, only valid when syntax is SYNTAX_EDITIONS. This field should be ignored, instead the edition should be inherited from Api. This is similar to Field and EnumValue.", +"type": "string" +}, "name": { "description": "The simple name of this method.", "type": "string" @@ -3443,7 +3546,8 @@ "type": "string" }, "syntax": { -"description": "The source syntax of this method.", +"deprecated": true, +"description": "The source syntax of this method. This field should be ignored, instead the syntax should be inherited from Api. This is similar to Field and EnumValue.", "enum": [ "SYNTAX_PROTO2", "SYNTAX_PROTO3", @@ -3870,7 +3974,7 @@ "type": "object" }, "Option": { -"description": "A protocol buffer option, which can be attached to a message, field, enumeration, etc.", +"description": "A protocol buffer option, which can be attached to a message, field, enumeration, etc. New usages of this message as an alternative to FileOptions, MessageOptions, FieldOptions, EnumOptions, EnumValueOptions, ServiceOptions, or MethodOptions are strongly discouraged.", "id": "Option", "properties": { "name": { @@ -4500,7 +4604,7 @@ "type": "object" }, "Type": { -"description": "A protocol buffer message type.", +"description": "A protocol buffer message type. New usages of this message as an alternative to DescriptorProto are strongly discouraged. This message does not reliability preserve all information necessary to model the schema and preserve semantics. Instead make use of FileDescriptorSet which preserves the necessary information.", "id": "Type", "properties": { "edition": { @@ -4565,6 +4669,12 @@ "properties": {}, "type": "object" }, +"UpdateMcpPolicyMetadata": { +"description": "Metadata for the `UpdateMcpPolicy` method.", +"id": "UpdateMcpPolicyMetadata", +"properties": {}, +"type": "object" +}, "Usage": { "description": "Configuration controlling usage of a service.", "id": "Usage", From e53f47018c6248f9f048ca5418a48f05d5fe09a8 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 30 Sep 2025 07:09:37 +0000 Subject: [PATCH 37/42] feat(sqladmin): update the api #### sqladmin:v1 The following keys were added: - resources.instances.methods.preCheckMajorVersionUpgrade (Total Keys: 14) - schemas.InstancesPreCheckMajorVersionUpgradeRequest (Total Keys: 3) - schemas.Operation.properties.preCheckMajorVersionUpgradeContext.$ref (Total Keys: 1) - schemas.PreCheckMajorVersionUpgradeContext (Total Keys: 7) - schemas.PreCheckResponse (Total Keys: 6) - schemas.ReadPoolAutoScaleConfig.properties.scaleInCooldownSeconds (Total Keys: 2) - schemas.ReadPoolAutoScaleConfig.properties.scaleOutCooldownSeconds (Total Keys: 2) #### sqladmin:v1beta4 The following keys were added: - resources.instances.methods.preCheckMajorVersionUpgrade (Total Keys: 14) - schemas.InstancesPreCheckMajorVersionUpgradeRequest (Total Keys: 3) - schemas.Operation.properties.preCheckMajorVersionUpgradeContext.$ref (Total Keys: 1) - schemas.PreCheckMajorVersionUpgradeContext (Total Keys: 7) - schemas.PreCheckResponse (Total Keys: 6) - schemas.ReadPoolAutoScaleConfig.properties.scaleInCooldownSeconds (Total Keys: 2) - schemas.ReadPoolAutoScaleConfig.properties.scaleOutCooldownSeconds (Total Keys: 2) --- docs/dyn/sqladmin_v1.Backups.html | 47 ++ docs/dyn/sqladmin_v1.backupRuns.html | 26 + docs/dyn/sqladmin_v1.databases.html | 52 ++ docs/dyn/sqladmin_v1.instances.html | 510 ++++++++++++++++++ docs/dyn/sqladmin_v1.operations.html | 26 + docs/dyn/sqladmin_v1.projects.instances.html | 52 ++ docs/dyn/sqladmin_v1.sslCerts.html | 26 + docs/dyn/sqladmin_v1.users.html | 39 ++ docs/dyn/sqladmin_v1beta4.backupRuns.html | 26 + docs/dyn/sqladmin_v1beta4.backups.html | 47 ++ docs/dyn/sqladmin_v1beta4.databases.html | 52 ++ docs/dyn/sqladmin_v1beta4.instances.html | 510 ++++++++++++++++++ docs/dyn/sqladmin_v1beta4.operations.html | 30 +- .../sqladmin_v1beta4.projects.instances.html | 52 ++ docs/dyn/sqladmin_v1beta4.sslCerts.html | 26 + docs/dyn/sqladmin_v1beta4.users.html | 39 ++ .../documents/sqladmin.v1.json | 292 +++++++++- .../documents/sqladmin.v1beta4.json | 294 +++++++++- 18 files changed, 2139 insertions(+), 7 deletions(-) diff --git a/docs/dyn/sqladmin_v1.Backups.html b/docs/dyn/sqladmin_v1.Backups.html index 6f337bcbd98..2e682874cd6 100644 --- a/docs/dyn/sqladmin_v1.Backups.html +++ b/docs/dyn/sqladmin_v1.Backups.html @@ -427,6 +427,8 @@

Method Details

"enabled": True or False, # Indicates whether read pool auto scaling is enabled. "maxNodeCount": 42, # Maximum number of read pool nodes to be maintained. "minNodeCount": 42, # Minimum number of read pool nodes to be maintained. + "scaleInCooldownSeconds": 42, # The cooldown period for scale-in operations. + "scaleOutCooldownSeconds": 42, # The cooldown period for scale-out operations. "targetMetrics": [ # Optional. Target metrics for read pool auto scaling. { # Target metric for read pool auto scaling. "metric": "A String", # The metric name to be used for auto scaling. @@ -616,6 +618,19 @@

Method Details

"kind": "A String", # This is always `sql#operation`. "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE` + "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found). + "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`. + "preCheckResponse": [ # Output only. The responses from the precheck operation. + { # Structured PreCheckResponse containing message, type, and required actions. + "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions. + "A String", + ], + "message": "A String", # The message to be displayed to the user. + "messageType": "A String", # The type of message whether it is an info, warning, or error. + }, + ], + "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to. + }, "selfLink": "A String", # The URI of this resource. "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. "status": "A String", # The status of an operation. @@ -766,6 +781,19 @@

Method Details

"kind": "A String", # This is always `sql#operation`. "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE` + "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found). + "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`. + "preCheckResponse": [ # Output only. The responses from the precheck operation. + { # Structured PreCheckResponse containing message, type, and required actions. + "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions. + "A String", + ], + "message": "A String", # The message to be displayed to the user. + "messageType": "A String", # The type of message whether it is an info, warning, or error. + }, + ], + "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to. + }, "selfLink": "A String", # The URI of this resource. "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. "status": "A String", # The status of an operation. @@ -1115,6 +1143,8 @@

Method Details

"enabled": True or False, # Indicates whether read pool auto scaling is enabled. "maxNodeCount": 42, # Maximum number of read pool nodes to be maintained. "minNodeCount": 42, # Minimum number of read pool nodes to be maintained. + "scaleInCooldownSeconds": 42, # The cooldown period for scale-in operations. + "scaleOutCooldownSeconds": 42, # The cooldown period for scale-out operations. "targetMetrics": [ # Optional. Target metrics for read pool auto scaling. { # Target metric for read pool auto scaling. "metric": "A String", # The metric name to be used for auto scaling. @@ -1515,6 +1545,8 @@

Method Details

"enabled": True or False, # Indicates whether read pool auto scaling is enabled. "maxNodeCount": 42, # Maximum number of read pool nodes to be maintained. "minNodeCount": 42, # Minimum number of read pool nodes to be maintained. + "scaleInCooldownSeconds": 42, # The cooldown period for scale-in operations. + "scaleOutCooldownSeconds": 42, # The cooldown period for scale-out operations. "targetMetrics": [ # Optional. Target metrics for read pool auto scaling. { # Target metric for read pool auto scaling. "metric": "A String", # The metric name to be used for auto scaling. @@ -1929,6 +1961,8 @@

Method Details

"enabled": True or False, # Indicates whether read pool auto scaling is enabled. "maxNodeCount": 42, # Maximum number of read pool nodes to be maintained. "minNodeCount": 42, # Minimum number of read pool nodes to be maintained. + "scaleInCooldownSeconds": 42, # The cooldown period for scale-in operations. + "scaleOutCooldownSeconds": 42, # The cooldown period for scale-out operations. "targetMetrics": [ # Optional. Target metrics for read pool auto scaling. { # Target metric for read pool auto scaling. "metric": "A String", # The metric name to be used for auto scaling. @@ -2119,6 +2153,19 @@

Method Details

"kind": "A String", # This is always `sql#operation`. "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE` + "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found). + "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`. + "preCheckResponse": [ # Output only. The responses from the precheck operation. + { # Structured PreCheckResponse containing message, type, and required actions. + "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions. + "A String", + ], + "message": "A String", # The message to be displayed to the user. + "messageType": "A String", # The type of message whether it is an info, warning, or error. + }, + ], + "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to. + }, "selfLink": "A String", # The URI of this resource. "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. "status": "A String", # The status of an operation. diff --git a/docs/dyn/sqladmin_v1.backupRuns.html b/docs/dyn/sqladmin_v1.backupRuns.html index 08073f0a2d5..184a0bf0e4e 100644 --- a/docs/dyn/sqladmin_v1.backupRuns.html +++ b/docs/dyn/sqladmin_v1.backupRuns.html @@ -237,6 +237,19 @@

Method Details

"kind": "A String", # This is always `sql#operation`. "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE` + "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found). + "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`. + "preCheckResponse": [ # Output only. The responses from the precheck operation. + { # Structured PreCheckResponse containing message, type, and required actions. + "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions. + "A String", + ], + "message": "A String", # The message to be displayed to the user. + "messageType": "A String", # The type of message whether it is an info, warning, or error. + }, + ], + "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to. + }, "selfLink": "A String", # The URI of this resource. "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. "status": "A String", # The status of an operation. @@ -472,6 +485,19 @@

Method Details

"kind": "A String", # This is always `sql#operation`. "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE` + "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found). + "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`. + "preCheckResponse": [ # Output only. The responses from the precheck operation. + { # Structured PreCheckResponse containing message, type, and required actions. + "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions. + "A String", + ], + "message": "A String", # The message to be displayed to the user. + "messageType": "A String", # The type of message whether it is an info, warning, or error. + }, + ], + "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to. + }, "selfLink": "A String", # The URI of this resource. "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. "status": "A String", # The status of an operation. diff --git a/docs/dyn/sqladmin_v1.databases.html b/docs/dyn/sqladmin_v1.databases.html index d10a55109c6..793d3cfca3c 100644 --- a/docs/dyn/sqladmin_v1.databases.html +++ b/docs/dyn/sqladmin_v1.databases.html @@ -240,6 +240,19 @@

Method Details

"kind": "A String", # This is always `sql#operation`. "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE` + "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found). + "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`. + "preCheckResponse": [ # Output only. The responses from the precheck operation. + { # Structured PreCheckResponse containing message, type, and required actions. + "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions. + "A String", + ], + "message": "A String", # The message to be displayed to the user. + "messageType": "A String", # The type of message whether it is an info, warning, or error. + }, + ], + "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to. + }, "selfLink": "A String", # The URI of this resource. "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. "status": "A String", # The status of an operation. @@ -441,6 +454,19 @@

Method Details

"kind": "A String", # This is always `sql#operation`. "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE` + "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found). + "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`. + "preCheckResponse": [ # Output only. The responses from the precheck operation. + { # Structured PreCheckResponse containing message, type, and required actions. + "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions. + "A String", + ], + "message": "A String", # The message to be displayed to the user. + "messageType": "A String", # The type of message whether it is an info, warning, or error. + }, + ], + "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to. + }, "selfLink": "A String", # The URI of this resource. "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. "status": "A String", # The status of an operation. @@ -647,6 +673,19 @@

Method Details

"kind": "A String", # This is always `sql#operation`. "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE` + "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found). + "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`. + "preCheckResponse": [ # Output only. The responses from the precheck operation. + { # Structured PreCheckResponse containing message, type, and required actions. + "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions. + "A String", + ], + "message": "A String", # The message to be displayed to the user. + "messageType": "A String", # The type of message whether it is an info, warning, or error. + }, + ], + "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to. + }, "selfLink": "A String", # The URI of this resource. "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. "status": "A String", # The status of an operation. @@ -817,6 +856,19 @@

Method Details

"kind": "A String", # This is always `sql#operation`. "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE` + "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found). + "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`. + "preCheckResponse": [ # Output only. The responses from the precheck operation. + { # Structured PreCheckResponse containing message, type, and required actions. + "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions. + "A String", + ], + "message": "A String", # The message to be displayed to the user. + "messageType": "A String", # The type of message whether it is an info, warning, or error. + }, + ], + "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to. + }, "selfLink": "A String", # The URI of this resource. "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. "status": "A String", # The status of an operation. diff --git a/docs/dyn/sqladmin_v1.instances.html b/docs/dyn/sqladmin_v1.instances.html index 5e7effe7fa4..89c7305e3f8 100644 --- a/docs/dyn/sqladmin_v1.instances.html +++ b/docs/dyn/sqladmin_v1.instances.html @@ -137,6 +137,9 @@

Instance Methods

pointInTimeRestore(parent, body=None, x__xgafv=None)

Point in time restore for an instance managed by Google Cloud Backup and Disaster Recovery.

+

+ preCheckMajorVersionUpgrade(project, instance, body=None, x__xgafv=None)

+

Execute MVU Pre-checks

promoteReplica(project, instance, failover=None, x__xgafv=None)

Promotes the read replica instance to be an independent Cloud SQL primary instance. Using this operation might cause your instance to restart.

@@ -369,6 +372,19 @@

Method Details

"kind": "A String", # This is always `sql#operation`. "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE` + "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found). + "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`. + "preCheckResponse": [ # Output only. The responses from the precheck operation. + { # Structured PreCheckResponse containing message, type, and required actions. + "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions. + "A String", + ], + "message": "A String", # The message to be displayed to the user. + "messageType": "A String", # The type of message whether it is an info, warning, or error. + }, + ], + "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to. + }, "selfLink": "A String", # The URI of this resource. "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. "status": "A String", # The status of an operation. @@ -552,6 +568,19 @@

Method Details

"kind": "A String", # This is always `sql#operation`. "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE` + "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found). + "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`. + "preCheckResponse": [ # Output only. The responses from the precheck operation. + { # Structured PreCheckResponse containing message, type, and required actions. + "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions. + "A String", + ], + "message": "A String", # The message to be displayed to the user. + "messageType": "A String", # The type of message whether it is an info, warning, or error. + }, + ], + "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to. + }, "selfLink": "A String", # The URI of this resource. "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. "status": "A String", # The status of an operation. @@ -703,6 +732,19 @@

Method Details

"kind": "A String", # This is always `sql#operation`. "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE` + "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found). + "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`. + "preCheckResponse": [ # Output only. The responses from the precheck operation. + { # Structured PreCheckResponse containing message, type, and required actions. + "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions. + "A String", + ], + "message": "A String", # The message to be displayed to the user. + "messageType": "A String", # The type of message whether it is an info, warning, or error. + }, + ], + "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to. + }, "selfLink": "A String", # The URI of this resource. "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. "status": "A String", # The status of an operation. @@ -878,6 +920,19 @@

Method Details

"kind": "A String", # This is always `sql#operation`. "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE` + "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found). + "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`. + "preCheckResponse": [ # Output only. The responses from the precheck operation. + { # Structured PreCheckResponse containing message, type, and required actions. + "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions. + "A String", + ], + "message": "A String", # The message to be displayed to the user. + "messageType": "A String", # The type of message whether it is an info, warning, or error. + }, + ], + "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to. + }, "selfLink": "A String", # The URI of this resource. "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. "status": "A String", # The status of an operation. @@ -1038,6 +1093,19 @@

Method Details

"kind": "A String", # This is always `sql#operation`. "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE` + "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found). + "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`. + "preCheckResponse": [ # Output only. The responses from the precheck operation. + { # Structured PreCheckResponse containing message, type, and required actions. + "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions. + "A String", + ], + "message": "A String", # The message to be displayed to the user. + "messageType": "A String", # The type of message whether it is an info, warning, or error. + }, + ], + "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to. + }, "selfLink": "A String", # The URI of this resource. "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. "status": "A String", # The status of an operation. @@ -1199,6 +1267,19 @@

Method Details

"kind": "A String", # This is always `sql#operation`. "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE` + "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found). + "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`. + "preCheckResponse": [ # Output only. The responses from the precheck operation. + { # Structured PreCheckResponse containing message, type, and required actions. + "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions. + "A String", + ], + "message": "A String", # The message to be displayed to the user. + "messageType": "A String", # The type of message whether it is an info, warning, or error. + }, + ], + "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to. + }, "selfLink": "A String", # The URI of this resource. "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. "status": "A String", # The status of an operation. @@ -1373,6 +1454,19 @@

Method Details

"kind": "A String", # This is always `sql#operation`. "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE` + "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found). + "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`. + "preCheckResponse": [ # Output only. The responses from the precheck operation. + { # Structured PreCheckResponse containing message, type, and required actions. + "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions. + "A String", + ], + "message": "A String", # The message to be displayed to the user. + "messageType": "A String", # The type of message whether it is an info, warning, or error. + }, + ], + "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to. + }, "selfLink": "A String", # The URI of this resource. "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. "status": "A String", # The status of an operation. @@ -1638,6 +1732,19 @@

Method Details

"kind": "A String", # This is always `sql#operation`. "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE` + "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found). + "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`. + "preCheckResponse": [ # Output only. The responses from the precheck operation. + { # Structured PreCheckResponse containing message, type, and required actions. + "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions. + "A String", + ], + "message": "A String", # The message to be displayed to the user. + "messageType": "A String", # The type of message whether it is an info, warning, or error. + }, + ], + "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to. + }, "selfLink": "A String", # The URI of this resource. "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. "status": "A String", # The status of an operation. @@ -1799,6 +1906,19 @@

Method Details

"kind": "A String", # This is always `sql#operation`. "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE` + "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found). + "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`. + "preCheckResponse": [ # Output only. The responses from the precheck operation. + { # Structured PreCheckResponse containing message, type, and required actions. + "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions. + "A String", + ], + "message": "A String", # The message to be displayed to the user. + "messageType": "A String", # The type of message whether it is an info, warning, or error. + }, + ], + "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to. + }, "selfLink": "A String", # The URI of this resource. "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. "status": "A String", # The status of an operation. @@ -2132,6 +2252,8 @@

Method Details

"enabled": True or False, # Indicates whether read pool auto scaling is enabled. "maxNodeCount": 42, # Maximum number of read pool nodes to be maintained. "minNodeCount": 42, # Minimum number of read pool nodes to be maintained. + "scaleInCooldownSeconds": 42, # The cooldown period for scale-in operations. + "scaleOutCooldownSeconds": 42, # The cooldown period for scale-out operations. "targetMetrics": [ # Optional. Target metrics for read pool auto scaling. { # Target metric for read pool auto scaling. "metric": "A String", # The metric name to be used for auto scaling. @@ -2366,6 +2488,19 @@

Method Details

"kind": "A String", # This is always `sql#operation`. "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE` + "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found). + "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`. + "preCheckResponse": [ # Output only. The responses from the precheck operation. + { # Structured PreCheckResponse containing message, type, and required actions. + "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions. + "A String", + ], + "message": "A String", # The message to be displayed to the user. + "messageType": "A String", # The type of message whether it is an info, warning, or error. + }, + ], + "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to. + }, "selfLink": "A String", # The URI of this resource. "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. "status": "A String", # The status of an operation. @@ -2693,6 +2828,8 @@

Method Details

"enabled": True or False, # Indicates whether read pool auto scaling is enabled. "maxNodeCount": 42, # Maximum number of read pool nodes to be maintained. "minNodeCount": 42, # Minimum number of read pool nodes to be maintained. + "scaleInCooldownSeconds": 42, # The cooldown period for scale-in operations. + "scaleOutCooldownSeconds": 42, # The cooldown period for scale-out operations. "targetMetrics": [ # Optional. Target metrics for read pool auto scaling. { # Target metric for read pool auto scaling. "metric": "A String", # The metric name to be used for auto scaling. @@ -2868,6 +3005,19 @@

Method Details

"kind": "A String", # This is always `sql#operation`. "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE` + "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found). + "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`. + "preCheckResponse": [ # Output only. The responses from the precheck operation. + { # Structured PreCheckResponse containing message, type, and required actions. + "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions. + "A String", + ], + "message": "A String", # The message to be displayed to the user. + "messageType": "A String", # The type of message whether it is an info, warning, or error. + }, + ], + "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to. + }, "selfLink": "A String", # The URI of this resource. "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. "status": "A String", # The status of an operation. @@ -3205,6 +3355,8 @@

Method Details

"enabled": True or False, # Indicates whether read pool auto scaling is enabled. "maxNodeCount": 42, # Maximum number of read pool nodes to be maintained. "minNodeCount": 42, # Minimum number of read pool nodes to be maintained. + "scaleInCooldownSeconds": 42, # The cooldown period for scale-in operations. + "scaleOutCooldownSeconds": 42, # The cooldown period for scale-out operations. "targetMetrics": [ # Optional. Target metrics for read pool auto scaling. { # Target metric for read pool auto scaling. "metric": "A String", # The metric name to be used for auto scaling. @@ -3624,6 +3776,8 @@

Method Details

"enabled": True or False, # Indicates whether read pool auto scaling is enabled. "maxNodeCount": 42, # Maximum number of read pool nodes to be maintained. "minNodeCount": 42, # Minimum number of read pool nodes to be maintained. + "scaleInCooldownSeconds": 42, # The cooldown period for scale-in operations. + "scaleOutCooldownSeconds": 42, # The cooldown period for scale-out operations. "targetMetrics": [ # Optional. Target metrics for read pool auto scaling. { # Target metric for read pool auto scaling. "metric": "A String", # The metric name to be used for auto scaling. @@ -3799,6 +3953,19 @@

Method Details

"kind": "A String", # This is always `sql#operation`. "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE` + "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found). + "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`. + "preCheckResponse": [ # Output only. The responses from the precheck operation. + { # Structured PreCheckResponse containing message, type, and required actions. + "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions. + "A String", + ], + "message": "A String", # The message to be displayed to the user. + "messageType": "A String", # The type of message whether it is an info, warning, or error. + }, + ], + "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to. + }, "selfLink": "A String", # The URI of this resource. "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. "status": "A String", # The status of an operation. @@ -3962,6 +4129,202 @@

Method Details

"kind": "A String", # This is always `sql#operation`. "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE` + "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found). + "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`. + "preCheckResponse": [ # Output only. The responses from the precheck operation. + { # Structured PreCheckResponse containing message, type, and required actions. + "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions. + "A String", + ], + "message": "A String", # The message to be displayed to the user. + "messageType": "A String", # The type of message whether it is an info, warning, or error. + }, + ], + "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to. + }, + "selfLink": "A String", # The URI of this resource. + "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. + "status": "A String", # The status of an operation. + "subOperationType": { # The sub operation type based on the operation type. # Optional. The sub operation based on the operation type. + "maintenanceType": "A String", # The type of maintenance to be performed on the instance. + }, + "targetId": "A String", # Name of the resource on which this operation runs. + "targetLink": "A String", + "targetProject": "A String", # The project ID of the target instance related to this operation. + "user": "A String", # The email address of the user who initiated this operation. +} + + +
+ preCheckMajorVersionUpgrade(project, instance, body=None, x__xgafv=None) + 
Execute MVU Pre-checks
+
+Args:
+  project: string, Required. Project ID of the project that contains the instance. (required)
+  instance: string, Required. Cloud SQL instance ID. This does not include the project ID. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for Pre-checks for MVU
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # Required. Contains details about the pre-check major version upgrade operation.
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.
+  "acquireSsrsLeaseContext": { # Acquire SSRS lease context. # The context for acquire SSRS lease operation, if applicable.
+    "duration": "A String", # Lease duration needed for SSRS setup.
+    "reportDatabase": "A String", # The report database to be used for SSRS setup.
+    "serviceLogin": "A String", # The username to be used as the service login to connect to the report database for SSRS setup.
+    "setupLogin": "A String", # The username to be used as the setup login to connect to the database server for SSRS setup.
+  },
+  "apiWarning": { # An Admin API warning message. # An Admin API warning message.
+    "code": "A String", # Code to uniquely identify the warning type.
+    "message": "A String", # The warning message.
+    "region": "A String", # The region name for REGION_UNREACHABLE warning.
+  },
+  "backupContext": { # Backup context. # The context for backup operation, if applicable.
+    "backupId": "A String", # The identifier of the backup.
+    "kind": "A String", # This is always `sql#backupContext`.
+    "name": "A String", # The name of the backup. Format: projects/{project}/backups/{backup}
+  },
+  "endTime": "A String", # The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
+  "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
+    "errors": [ # The list of errors encountered while processing this operation.
+      { # Database instance operation error.
+        "code": "A String", # Identifies the specific error that occurred.
+        "kind": "A String", # This is always `sql#operationError`.
+        "message": "A String", # Additional information about the error encountered.
+      },
+    ],
+    "kind": "A String", # This is always `sql#operationErrors`.
+  },
+  "exportContext": { # Database instance export context. # The context for export operation, if applicable.
+    "bakExportOptions": { # Options for exporting BAK files (SQL Server-only)
+      "bakType": "A String", # Type of this bak file will be export, FULL or DIFF, SQL Server only
+      "copyOnly": True or False, # Deprecated: copy_only is deprecated. Use differential_base instead
+      "differentialBase": True or False, # Whether or not the backup can be used as a differential base copy_only backup can not be served as differential base
+      "exportLogEndTime": "A String", # Optional. The end timestamp when transaction log will be included in the export operation. [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example, `2023-10-01T16:19:00.094`) in UTC. When omitted, all available logs until current time will be included. Only applied to Cloud SQL for SQL Server.
+      "exportLogStartTime": "A String", # Optional. The begin timestamp when transaction log will be included in the export operation. [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example, `2023-10-01T16:19:00.094`) in UTC. When omitted, all available logs from the beginning of retention period will be included. Only applied to Cloud SQL for SQL Server.
+      "stripeCount": 42, # Option for specifying how many stripes to use for the export. If blank, and the value of the striped field is true, the number of stripes is automatically chosen.
+      "striped": True or False, # Whether or not the export should be striped.
+    },
+    "csvExportOptions": { # Options for exporting data as CSV. `MySQL` and `PostgreSQL` instances only.
+      "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.
+      "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.
+      "linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.
+      "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.
+      "selectQuery": "A String", # The select query used to extract the data.
+    },
+    "databases": [ # Databases to be exported. `MySQL instances:` If `fileType` is `SQL` and no database is specified, all databases are exported, except for the `mysql` system database. If `fileType` is `CSV`, you can specify one database, either by using this property or by using the `csvExportOptions.selectQuery` property, which takes precedence over this property. `PostgreSQL instances:` If you don't specify a database by name, all user databases in the instance are exported. This excludes system databases and Cloud SQL databases used to manage internal operations. Exporting all user databases is only available for directory-formatted parallel export. If `fileType` is `CSV`, this database must match the one specified in the `csvExportOptions.selectQuery` property. `SQL Server instances:` You must specify one database to be exported, and the `fileType` must be `BAK`.
+      "A String",
+    ],
+    "fileType": "A String", # The file type for the specified uri.
+    "kind": "A String", # This is always `sql#exportContext`.
+    "offload": True or False, # Whether to perform a serverless export.
+    "sqlExportOptions": { # Options for exporting data as SQL statements.
+      "mysqlExportOptions": { # Options for exporting from MySQL.
+        "masterData": 42, # Option to include SQL statement required to set up replication. If set to `1`, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates, and --set-gtid-purged is set to ON. If set to `2`, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. If set to any value other than `1`, --set-gtid-purged is set to OFF.
+      },
+      "parallel": True or False, # Optional. Whether or not the export should be parallel.
+      "postgresExportOptions": { # Options for exporting from a Cloud SQL for PostgreSQL instance.
+        "clean": True or False, # Optional. Use this option to include DROP <object> SQL statements. Use these statements to delete database objects before running the import operation.
+        "ifExists": True or False, # Optional. Option to include an IF EXISTS SQL statement with each DROP statement produced by clean.
+      },
+      "schemaOnly": True or False, # Export only schemas.
+      "tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table.
+        "A String",
+      ],
+      "threads": 42, # Optional. The number of threads to use for parallel export.
+    },
+    "tdeExportOptions": { # Optional. Export parameters specific to SQL Server TDE certificates
+      "certificatePath": "A String", # Required. Path to the TDE certificate public key in the form gs://bucketName/fileName. The instance must have write access to the bucket. Applicable only for SQL Server instances.
+      "name": "A String", # Required. Certificate name. Applicable only for SQL Server instances.
+      "privateKeyPassword": "A String", # Required. Password that encrypts the private key.
+      "privateKeyPath": "A String", # Required. Path to the TDE certificate private key in the form gs://bucketName/fileName. The instance must have write access to the location. Applicable only for SQL Server instances.
+    },
+    "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form `gs://bucketName/fileName`. If the file already exists, the request succeeds, but the operation fails. If `fileType` is `SQL` and the filename ends with .gz, the contents are compressed.
+  },
+  "importContext": { # Database instance import context. # The context for import operation, if applicable.
+    "bakImportOptions": { # Import parameters specific to SQL Server .BAK files
+      "bakType": "A String", # Type of the bak content, FULL or DIFF
+      "encryptionOptions": {
+        "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form `gs://bucketName/fileName`. The instance must have write permissions to the bucket and read access to the file.
+        "keepEncrypted": True or False, # Optional. Whether the imported file remains encrypted.
+        "pvkPassword": "A String", # Password that encrypts the private key
+        "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form `gs://bucketName/fileName`. The instance must have write permissions to the bucket and read access to the file.
+      },
+      "noRecovery": True or False, # Whether or not the backup importing will restore database with NORECOVERY option Applies only to Cloud SQL for SQL Server.
+      "recoveryOnly": True or False, # Whether or not the backup importing request will just bring database online without downloading Bak content only one of "no_recovery" and "recovery_only" can be true otherwise error will return. Applies only to Cloud SQL for SQL Server.
+      "stopAt": "A String", # Optional. The timestamp when the import should stop. This timestamp is in the [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example, `2023-10-01T16:19:00.094`). This field is equivalent to the STOPAT keyword and applies to Cloud SQL for SQL Server only.
+      "stopAtMark": "A String", # Optional. The marked transaction where the import should stop. This field is equivalent to the STOPATMARK keyword and applies to Cloud SQL for SQL Server only.
+      "striped": True or False, # Whether or not the backup set being restored is striped. Applies only to Cloud SQL for SQL Server.
+    },
+    "csvImportOptions": { # Options for importing data as CSV.
+      "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
+        "A String",
+      ],
+      "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.
+      "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.
+      "linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.
+      "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.
+      "table": "A String", # The table to which CSV data is imported.
+    },
+    "database": "A String", # The target database for the import. If `fileType` is `SQL`, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. For entire instance parallel import operations, the database is overridden by the database name stored in subdirectory name. If `fileType` is `CSV`, one database must be specified.
+    "fileType": "A String", # The file type for the specified uri.\`SQL`: The file contains SQL statements. \`CSV`: The file contains CSV data.
+    "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
+    "kind": "A String", # This is always `sql#importContext`.
+    "sqlImportOptions": { # Optional. Options for importing data from SQL statements.
+      "parallel": True or False, # Optional. Whether or not the import should be parallel.
+      "postgresImportOptions": { # Optional. Options for importing from a Cloud SQL for PostgreSQL instance.
+        "clean": True or False, # Optional. The --clean flag for the pg_restore utility. This flag applies only if you enabled Cloud SQL to import files in parallel.
+        "ifExists": True or False, # Optional. The --if-exists flag for the pg_restore utility. This flag applies only if you enabled Cloud SQL to import files in parallel.
+      },
+      "threads": 42, # Optional. The number of threads to use for parallel import.
+    },
+    "tdeImportOptions": { # Optional. Import parameters specific to SQL Server TDE certificates
+      "certificatePath": "A String", # Required. Path to the TDE certificate public key in the form gs://bucketName/fileName. The instance must have read access to the file. Applicable only for SQL Server instances.
+      "name": "A String", # Required. Certificate name. Applicable only for SQL Server instances.
+      "privateKeyPassword": "A String", # Required. Password that encrypts the private key.
+      "privateKeyPath": "A String", # Required. Path to the TDE certificate private key in the form gs://bucketName/fileName. The instance must have read access to the file. Applicable only for SQL Server instances.
+    },
+    "uri": "A String", # Path to the import file in Cloud Storage, in the form `gs://bucketName/fileName`. Compressed gzip files (.gz) are supported when `fileType` is `SQL`. The instance must have write permissions to the bucket and read access to the file.
+  },
+  "insertTime": "A String", # The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
+  "kind": "A String", # This is always `sql#operation`.
+  "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
+  "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -4114,6 +4477,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -4275,6 +4651,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -4451,6 +4840,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -4602,6 +5004,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -4942,6 +5357,8 @@ 
Method Details

         "enabled": True or False, # Indicates whether read pool auto scaling is enabled.
         "maxNodeCount": 42, # Maximum number of read pool nodes to be maintained.
         "minNodeCount": 42, # Minimum number of read pool nodes to be maintained.
+        "scaleInCooldownSeconds": 42, # The cooldown period for scale-in operations.
+        "scaleOutCooldownSeconds": 42, # The cooldown period for scale-out operations.
         "targetMetrics": [ # Optional. Target metrics for read pool auto scaling.
           { # Target metric for read pool auto scaling.
             "metric": "A String", # The metric name to be used for auto scaling.
@@ -5118,6 +5535,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -5279,6 +5709,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -5430,6 +5873,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -5581,6 +6037,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -5733,6 +6202,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -5894,6 +6376,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -6222,6 +6717,8 @@ 
Method Details

       "enabled": True or False, # Indicates whether read pool auto scaling is enabled.
       "maxNodeCount": 42, # Maximum number of read pool nodes to be maintained.
       "minNodeCount": 42, # Minimum number of read pool nodes to be maintained.
+      "scaleInCooldownSeconds": 42, # The cooldown period for scale-in operations.
+      "scaleOutCooldownSeconds": 42, # The cooldown period for scale-out operations.
       "targetMetrics": [ # Optional. Target metrics for read pool auto scaling.
         { # Target metric for read pool auto scaling.
           "metric": "A String", # The metric name to be used for auto scaling.
@@ -6397,6 +6894,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
diff --git a/docs/dyn/sqladmin_v1.operations.html b/docs/dyn/sqladmin_v1.operations.html
index 2e2e7697e39..ab0ed8c4bb2 100644
--- a/docs/dyn/sqladmin_v1.operations.html
+++ b/docs/dyn/sqladmin_v1.operations.html
@@ -252,6 +252,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -407,6 +420,19 @@ 
Method Details

       "kind": "A String", # This is always `sql#operation`.
       "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
       "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+      "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+        "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+        "preCheckResponse": [ # Output only. The responses from the precheck operation.
+          { # Structured PreCheckResponse containing message, type, and required actions.
+            "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+              "A String",
+            ],
+            "message": "A String", # The message to be displayed to the user.
+            "messageType": "A String", # The type of message whether it is an info, warning, or error.
+          },
+        ],
+        "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+      },
       "selfLink": "A String", # The URI of this resource.
       "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
       "status": "A String", # The status of an operation.
diff --git a/docs/dyn/sqladmin_v1.projects.instances.html b/docs/dyn/sqladmin_v1.projects.instances.html
index 9c4e82d489d..32590d1fbd8 100644
--- a/docs/dyn/sqladmin_v1.projects.instances.html
+++ b/docs/dyn/sqladmin_v1.projects.instances.html
@@ -294,6 +294,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -455,6 +468,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -612,6 +638,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -782,6 +821,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
diff --git a/docs/dyn/sqladmin_v1.sslCerts.html b/docs/dyn/sqladmin_v1.sslCerts.html
index 8c34b0dcb02..3f2768d0899 100644
--- a/docs/dyn/sqladmin_v1.sslCerts.html
+++ b/docs/dyn/sqladmin_v1.sslCerts.html
@@ -273,6 +273,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -476,6 +489,19 @@ 
Method Details

     "kind": "A String", # This is always `sql#operation`.
     "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
     "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+    "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+      "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+      "preCheckResponse": [ # Output only. The responses from the precheck operation.
+        { # Structured PreCheckResponse containing message, type, and required actions.
+          "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+            "A String",
+          ],
+          "message": "A String", # The message to be displayed to the user.
+          "messageType": "A String", # The type of message whether it is an info, warning, or error.
+        },
+      ],
+      "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+    },
     "selfLink": "A String", # The URI of this resource.
     "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
     "status": "A String", # The status of an operation.
diff --git a/docs/dyn/sqladmin_v1.users.html b/docs/dyn/sqladmin_v1.users.html
index 4c0acb725b1..94e5f25404a 100644
--- a/docs/dyn/sqladmin_v1.users.html
+++ b/docs/dyn/sqladmin_v1.users.html
@@ -238,6 +238,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -468,6 +481,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -704,6 +730,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
diff --git a/docs/dyn/sqladmin_v1beta4.backupRuns.html b/docs/dyn/sqladmin_v1beta4.backupRuns.html
index 2bb585afa15..0759263fb9d 100644
--- a/docs/dyn/sqladmin_v1beta4.backupRuns.html
+++ b/docs/dyn/sqladmin_v1beta4.backupRuns.html
@@ -237,6 +237,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -472,6 +485,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
diff --git a/docs/dyn/sqladmin_v1beta4.backups.html b/docs/dyn/sqladmin_v1beta4.backups.html
index e44b25c5f57..2adfabd3b3a 100644
--- a/docs/dyn/sqladmin_v1beta4.backups.html
+++ b/docs/dyn/sqladmin_v1beta4.backups.html
@@ -432,6 +432,8 @@ 
Method Details

         "enabled": True or False, # Indicates whether read pool auto scaling is enabled.
         "maxNodeCount": 42, # Maximum number of read pool nodes to be maintained.
         "minNodeCount": 42, # Minimum number of read pool nodes to be maintained.
+        "scaleInCooldownSeconds": 42, # The cooldown period for scale in operations.
+        "scaleOutCooldownSeconds": 42, # The cooldown period for scale out operations.
         "targetMetrics": [ # Optional. Target metrics for read pool auto scaling.
           { # Target metric for read pool auto scaling.
             "metric": "A String", # The metric name to be used for auto scaling.
@@ -621,6 +623,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -771,6 +786,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -1120,6 +1148,8 @@ 
Method Details

         "enabled": True or False, # Indicates whether read pool auto scaling is enabled.
         "maxNodeCount": 42, # Maximum number of read pool nodes to be maintained.
         "minNodeCount": 42, # Minimum number of read pool nodes to be maintained.
+        "scaleInCooldownSeconds": 42, # The cooldown period for scale in operations.
+        "scaleOutCooldownSeconds": 42, # The cooldown period for scale out operations.
         "targetMetrics": [ # Optional. Target metrics for read pool auto scaling.
           { # Target metric for read pool auto scaling.
             "metric": "A String", # The metric name to be used for auto scaling.
@@ -1520,6 +1550,8 @@ 
Method Details

             "enabled": True or False, # Indicates whether read pool auto scaling is enabled.
             "maxNodeCount": 42, # Maximum number of read pool nodes to be maintained.
             "minNodeCount": 42, # Minimum number of read pool nodes to be maintained.
+            "scaleInCooldownSeconds": 42, # The cooldown period for scale in operations.
+            "scaleOutCooldownSeconds": 42, # The cooldown period for scale out operations.
             "targetMetrics": [ # Optional. Target metrics for read pool auto scaling.
               { # Target metric for read pool auto scaling.
                 "metric": "A String", # The metric name to be used for auto scaling.
@@ -1934,6 +1966,8 @@ 
Method Details

         "enabled": True or False, # Indicates whether read pool auto scaling is enabled.
         "maxNodeCount": 42, # Maximum number of read pool nodes to be maintained.
         "minNodeCount": 42, # Minimum number of read pool nodes to be maintained.
+        "scaleInCooldownSeconds": 42, # The cooldown period for scale in operations.
+        "scaleOutCooldownSeconds": 42, # The cooldown period for scale out operations.
         "targetMetrics": [ # Optional. Target metrics for read pool auto scaling.
           { # Target metric for read pool auto scaling.
             "metric": "A String", # The metric name to be used for auto scaling.
@@ -2124,6 +2158,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
diff --git a/docs/dyn/sqladmin_v1beta4.databases.html b/docs/dyn/sqladmin_v1beta4.databases.html
index 3abb470e591..dd5b4effc70 100644
--- a/docs/dyn/sqladmin_v1beta4.databases.html
+++ b/docs/dyn/sqladmin_v1beta4.databases.html
@@ -240,6 +240,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -441,6 +454,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -647,6 +673,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -817,6 +856,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
diff --git a/docs/dyn/sqladmin_v1beta4.instances.html b/docs/dyn/sqladmin_v1beta4.instances.html
index 6314e1f5abe..3879608c38d 100644
--- a/docs/dyn/sqladmin_v1beta4.instances.html
+++ b/docs/dyn/sqladmin_v1beta4.instances.html
@@ -137,6 +137,9 @@ 
Instance Methods

 

   pointInTimeRestore(parent, body=None, x__xgafv=None)

 
Point in time restore for an instance managed by Google Cloud Backup and Disaster Recovery.

+

+  preCheckMajorVersionUpgrade(project, instance, body=None, x__xgafv=None)

+
Execute MVU Pre-checks

 

   promoteReplica(project, instance, failover=None, x__xgafv=None)

 
Promotes the read replica instance to be an independent Cloud SQL primary instance. Using this operation might cause your instance to restart.

@@ -369,6 +372,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -552,6 +568,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -703,6 +732,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -878,6 +920,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -1038,6 +1093,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -1199,6 +1267,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -1373,6 +1454,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -1638,6 +1732,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -1799,6 +1906,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -2132,6 +2252,8 @@ 
Method Details

       "enabled": True or False, # Indicates whether read pool auto scaling is enabled.
       "maxNodeCount": 42, # Maximum number of read pool nodes to be maintained.
       "minNodeCount": 42, # Minimum number of read pool nodes to be maintained.
+      "scaleInCooldownSeconds": 42, # The cooldown period for scale in operations.
+      "scaleOutCooldownSeconds": 42, # The cooldown period for scale out operations.
       "targetMetrics": [ # Optional. Target metrics for read pool auto scaling.
         { # Target metric for read pool auto scaling.
           "metric": "A String", # The metric name to be used for auto scaling.
@@ -2366,6 +2488,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -2693,6 +2828,8 @@ 
Method Details

       "enabled": True or False, # Indicates whether read pool auto scaling is enabled.
       "maxNodeCount": 42, # Maximum number of read pool nodes to be maintained.
       "minNodeCount": 42, # Minimum number of read pool nodes to be maintained.
+      "scaleInCooldownSeconds": 42, # The cooldown period for scale in operations.
+      "scaleOutCooldownSeconds": 42, # The cooldown period for scale out operations.
       "targetMetrics": [ # Optional. Target metrics for read pool auto scaling.
         { # Target metric for read pool auto scaling.
           "metric": "A String", # The metric name to be used for auto scaling.
@@ -2868,6 +3005,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -3205,6 +3355,8 @@ 
Method Details

           "enabled": True or False, # Indicates whether read pool auto scaling is enabled.
           "maxNodeCount": 42, # Maximum number of read pool nodes to be maintained.
           "minNodeCount": 42, # Minimum number of read pool nodes to be maintained.
+          "scaleInCooldownSeconds": 42, # The cooldown period for scale in operations.
+          "scaleOutCooldownSeconds": 42, # The cooldown period for scale out operations.
           "targetMetrics": [ # Optional. Target metrics for read pool auto scaling.
             { # Target metric for read pool auto scaling.
               "metric": "A String", # The metric name to be used for auto scaling.
@@ -3624,6 +3776,8 @@ 
Method Details

       "enabled": True or False, # Indicates whether read pool auto scaling is enabled.
       "maxNodeCount": 42, # Maximum number of read pool nodes to be maintained.
       "minNodeCount": 42, # Minimum number of read pool nodes to be maintained.
+      "scaleInCooldownSeconds": 42, # The cooldown period for scale in operations.
+      "scaleOutCooldownSeconds": 42, # The cooldown period for scale out operations.
       "targetMetrics": [ # Optional. Target metrics for read pool auto scaling.
         { # Target metric for read pool auto scaling.
           "metric": "A String", # The metric name to be used for auto scaling.
@@ -3799,6 +3953,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -3962,6 +4129,202 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
+  "selfLink": "A String", # The URI of this resource.
+  "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
+  "status": "A String", # The status of an operation.
+  "subOperationType": { # The sub operation type based on the operation type. # Optional. The sub operation based on the operation type.
+    "maintenanceType": "A String", # The type of maintenance to be performed on the instance.
+  },
+  "targetId": "A String", # Name of the resource on which this operation runs.
+  "targetLink": "A String",
+  "targetProject": "A String", # The project ID of the target instance related to this operation.
+  "user": "A String", # The email address of the user who initiated this operation.
+}
+
+ +
+ preCheckMajorVersionUpgrade(project, instance, body=None, x__xgafv=None) + 
Execute MVU Pre-checks
+
+Args:
+  project: string, Required. Project ID of the project that contains the instance. (required)
+  instance: string, Required. Cloud SQL instance ID. This does not include the project ID. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for Pre-checks for MVU
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # Required. Contains details about the pre-check major version upgrade operation.
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.
+  "acquireSsrsLeaseContext": { # Acquire SSRS lease context. # The context for acquire SSRS lease operation, if applicable.
+    "duration": "A String", # Lease duration needed for the SSRS setup.
+    "reportDatabase": "A String", # The report database to be used for the SSRS setup.
+    "serviceLogin": "A String", # The username to be used as the service login to connect to the report database for SSRS setup.
+    "setupLogin": "A String", # The username to be used as the setup login to connect to the database server for SSRS setup.
+  },
+  "apiWarning": { # An Admin API warning message. # An Admin API warning message.
+    "code": "A String", # Code to uniquely identify the warning type.
+    "message": "A String", # The warning message.
+    "region": "A String", # The region name for REGION_UNREACHABLE warning.
+  },
+  "backupContext": { # Backup context. # The context for backup operation, if applicable.
+    "backupId": "A String", # The identifier of the backup.
+    "kind": "A String", # This is always `sql#backupContext`.
+    "name": "A String", # The name of the backup. Format: projects/{project}/backups/{backup}
+  },
+  "endTime": "A String", # The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
+  "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
+    "errors": [ # The list of errors encountered while processing this operation.
+      { # Database instance operation error.
+        "code": "A String", # Identifies the specific error that occurred.
+        "kind": "A String", # This is always `sql#operationError`.
+        "message": "A String", # Additional information about the error encountered.
+      },
+    ],
+    "kind": "A String", # This is always `sql#operationErrors`.
+  },
+  "exportContext": { # Database instance export context. # The context for export operation, if applicable.
+    "bakExportOptions": { # Options for exporting BAK files (SQL Server-only)
+      "bakType": "A String", # Type of this bak file will be export, FULL or DIFF, SQL Server only
+      "copyOnly": True or False, # Deprecated: copy_only is deprecated. Use differential_base instead
+      "differentialBase": True or False, # Whether or not the backup can be used as a differential base copy_only backup can not be served as differential base
+      "exportLogEndTime": "A String", # Optional. The end timestamp when transaction log will be included in the export operation. [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example, `2023-10-01T16:19:00.094`) in UTC. When omitted, all available logs until current time will be included. Only applied to Cloud SQL for SQL Server.
+      "exportLogStartTime": "A String", # Optional. The begin timestamp when transaction log will be included in the export operation. [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example, `2023-10-01T16:19:00.094`) in UTC. When omitted, all available logs from the beginning of retention period will be included. Only applied to Cloud SQL for SQL Server.
+      "stripeCount": 42, # Option for specifying how many stripes to use for the export. If blank, and the value of the striped field is true, the number of stripes is automatically chosen.
+      "striped": True or False, # Whether or not the export should be striped.
+    },
+    "csvExportOptions": { # Options for exporting data as CSV. `MySQL` and `PostgreSQL` instances only.
+      "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.
+      "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.
+      "linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.
+      "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.
+      "selectQuery": "A String", # The select query used to extract the data.
+    },
+    "databases": [ # Databases to be exported. `MySQL instances:` If `fileType` is `SQL` and no database is specified, all databases are exported, except for the `mysql` system database. If `fileType` is `CSV`, you can specify one database, either by using this property or by using the `csvExportOptions.selectQuery` property, which takes precedence over this property. `PostgreSQL instances:` If you don't specify a database by name, all user databases in the instance are exported. This excludes system databases and Cloud SQL databases used to manage internal operations. Exporting all user databases is only available for directory-formatted parallel export. If `fileType` is `CSV`, this database must match the one specified in the `csvExportOptions.selectQuery` property. `SQL Server instances:` You must specify one database to be exported, and the `fileType` must be `BAK`.
+      "A String",
+    ],
+    "fileType": "A String", # The file type for the specified uri.
+    "kind": "A String", # This is always `sql#exportContext`.
+    "offload": True or False, # Whether to perform a serverless export.
+    "sqlExportOptions": { # Options for exporting data as SQL statements.
+      "mysqlExportOptions": { # Options for exporting from MySQL.
+        "masterData": 42, # Option to include SQL statement required to set up replication. If set to `1`, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates, and --set-gtid-purged is set to ON. If set to `2`, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. If set to any value other than `1`, --set-gtid-purged is set to OFF.
+      },
+      "parallel": True or False, # Optional. Whether or not the export should be parallel.
+      "postgresExportOptions": { # Options for exporting from a Cloud SQL for PostgreSQL instance.
+        "clean": True or False, # Optional. Use this option to include DROP <object> SQL statements. Use these statements to delete database objects before running the import operation.
+        "ifExists": True or False, # Optional. Option to include an IF EXISTS SQL statement with each DROP statement produced by clean.
+      },
+      "schemaOnly": True or False, # Export only schemas.
+      "tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table.
+        "A String",
+      ],
+      "threads": 42, # Optional. The number of threads to use for parallel export.
+    },
+    "tdeExportOptions": { # Optional. Export parameters specific to SQL Server TDE certificates
+      "certificatePath": "A String", # Required. Path to the TDE certificate public key in the form gs://bucketName/fileName. The instance must have write access to the location. Applicable only for SQL Server instances.
+      "name": "A String", # Required. Certificate name. Applicable only for SQL Server instances.
+      "privateKeyPassword": "A String", # Required. Password that encrypts the private key.
+      "privateKeyPath": "A String", # Required. Path to the TDE certificate private key in the form gs://bucketName/fileName. The instance must have write access to the location. Applicable only for SQL Server instances.
+    },
+    "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form `gs://bucketName/fileName`. If the file already exists, the request succeeds, but the operation fails. If `fileType` is `SQL` and the filename ends with .gz, the contents are compressed.
+  },
+  "importContext": { # Database instance import context. # The context for import operation, if applicable.
+    "bakImportOptions": { # Import parameters specific to SQL Server .BAK files
+      "bakType": "A String", # Type of the bak content, FULL or DIFF.
+      "encryptionOptions": {
+        "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form `gs://bucketName/fileName`. The instance must have write permissions to the bucket and read access to the file.
+        "keepEncrypted": True or False, # Optional. Whether the imported file remains encrypted.
+        "pvkPassword": "A String", # Password that encrypts the private key
+        "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form `gs://bucketName/fileName`. The instance must have write permissions to the bucket and read access to the file.
+      },
+      "noRecovery": True or False, # Whether or not the backup importing will restore database with NORECOVERY option Applies only to Cloud SQL for SQL Server.
+      "recoveryOnly": True or False, # Whether or not the backup importing request will just bring database online without downloading Bak content only one of "no_recovery" and "recovery_only" can be true otherwise error will return. Applies only to Cloud SQL for SQL Server.
+      "stopAt": "A String", # Optional. The timestamp when the import should stop. This timestamp is in the [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example, `2023-10-01T16:19:00.094`). This field is equivalent to the STOPAT keyword and applies to Cloud SQL for SQL Server only.
+      "stopAtMark": "A String", # Optional. The marked transaction where the import should stop. This field is equivalent to the STOPATMARK keyword and applies to Cloud SQL for SQL Server only.
+      "striped": True or False, # Whether or not the backup set being restored is striped. Applies only to Cloud SQL for SQL Server.
+    },
+    "csvImportOptions": { # Options for importing data as CSV.
+      "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
+        "A String",
+      ],
+      "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.
+      "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.
+      "linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.
+      "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.
+      "table": "A String", # The table to which CSV data is imported.
+    },
+    "database": "A String", # The target database for the import. If `fileType` is `SQL`, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. For entire instance parallel import operations, the database is overridden by the database name stored in subdirectory name. If `fileType` is `CSV`, one database must be specified.
+    "fileType": "A String", # The file type for the specified uri. * `SQL`: The file contains SQL statements. * `CSV`: The file contains CSV data. * `BAK`: The file contains backup data for a SQL Server instance.
+    "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
+    "kind": "A String", # This is always `sql#importContext`.
+    "sqlImportOptions": { # Optional. Options for importing data from SQL statements.
+      "parallel": True or False, # Optional. Whether or not the import should be parallel.
+      "postgresImportOptions": { # Optional. Options for importing from a Cloud SQL for PostgreSQL instance.
+        "clean": True or False, # Optional. The --clean flag for the pg_restore utility. This flag applies only if you enabled Cloud SQL to import files in parallel.
+        "ifExists": True or False, # Optional. The --if-exists flag for the pg_restore utility. This flag applies only if you enabled Cloud SQL to import files in parallel.
+      },
+      "threads": 42, # Optional. The number of threads to use for parallel import.
+    },
+    "tdeImportOptions": { # Optional. Import parameters specific to SQL Server .TDE files Import parameters specific to SQL Server TDE certificates
+      "certificatePath": "A String", # Required. Path to the TDE certificate public key in the form gs://bucketName/fileName. The instance must have read access to the file. Applicable only for SQL Server instances.
+      "name": "A String", # Required. Certificate name. Applicable only for SQL Server instances.
+      "privateKeyPassword": "A String", # Required. Password that encrypts the private key.
+      "privateKeyPath": "A String", # Required. Path to the TDE certificate private key in the form gs://bucketName/fileName. The instance must have read access to the file. Applicable only for SQL Server instances.
+    },
+    "uri": "A String", # Path to the import file in Cloud Storage, in the form `gs://bucketName/fileName`. Compressed gzip files (.gz) are supported when `fileType` is `SQL`. The instance must have write permissions to the bucket and read access to the file.
+  },
+  "insertTime": "A String", # The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
+  "kind": "A String", # This is always `sql#operation`.
+  "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
+  "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -4114,6 +4477,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -4275,6 +4651,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -4451,6 +4840,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -4602,6 +5004,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -4942,6 +5357,8 @@ 
Method Details

         "enabled": True or False, # Indicates whether read pool auto scaling is enabled.
         "maxNodeCount": 42, # Maximum number of read pool nodes to be maintained.
         "minNodeCount": 42, # Minimum number of read pool nodes to be maintained.
+        "scaleInCooldownSeconds": 42, # The cooldown period for scale in operations.
+        "scaleOutCooldownSeconds": 42, # The cooldown period for scale out operations.
         "targetMetrics": [ # Optional. Target metrics for read pool auto scaling.
           { # Target metric for read pool auto scaling.
             "metric": "A String", # The metric name to be used for auto scaling.
@@ -5118,6 +5535,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -5279,6 +5709,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -5430,6 +5873,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -5581,6 +6037,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -5733,6 +6202,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -5894,6 +6376,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -6222,6 +6717,8 @@ 
Method Details

       "enabled": True or False, # Indicates whether read pool auto scaling is enabled.
       "maxNodeCount": 42, # Maximum number of read pool nodes to be maintained.
       "minNodeCount": 42, # Minimum number of read pool nodes to be maintained.
+      "scaleInCooldownSeconds": 42, # The cooldown period for scale in operations.
+      "scaleOutCooldownSeconds": 42, # The cooldown period for scale out operations.
       "targetMetrics": [ # Optional. Target metrics for read pool auto scaling.
         { # Target metric for read pool auto scaling.
           "metric": "A String", # The metric name to be used for auto scaling.
@@ -6397,6 +6894,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
diff --git a/docs/dyn/sqladmin_v1beta4.operations.html b/docs/dyn/sqladmin_v1beta4.operations.html
index 25923fd5aff..e1509261606 100644
--- a/docs/dyn/sqladmin_v1beta4.operations.html
+++ b/docs/dyn/sqladmin_v1beta4.operations.html
@@ -76,7 +76,7 @@ 
Cloud SQL Admin API . 
   cancel(project, operation, x__xgafv=None)

-
Cancels an instance operation that has been performed on an instance.

+
Cancels an instance operation that has been performed on an instance. Ordinarily, this method name should be `CancelSqlOperation`.

 

   close()

 
Close httplib2 connections.

@@ -92,7 +92,7 @@ 
Instance Methods

 
Method Details

 

     cancel(project, operation, x__xgafv=None)
-  
Cancels an instance operation that has been performed on an instance.
+  
Cancels an instance operation that has been performed on an instance. Ordinarily, this method name should be `CancelSqlOperation`.
 
 Args:
   project: string, Project ID of the project that contains the instance. (required)
@@ -252,6 +252,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -407,6 +420,19 @@ 
Method Details

       "kind": "A String", # This is always `sql#operation`.
       "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
       "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+      "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+        "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+        "preCheckResponse": [ # Output only. The responses from the precheck operation.
+          { # Structured PreCheckResponse containing message, type, and required actions.
+            "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+              "A String",
+            ],
+            "message": "A String", # The message to be displayed to the user.
+            "messageType": "A String", # The type of message whether it is an info, warning, or error.
+          },
+        ],
+        "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+      },
       "selfLink": "A String", # The URI of this resource.
       "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
       "status": "A String", # The status of an operation.
diff --git a/docs/dyn/sqladmin_v1beta4.projects.instances.html b/docs/dyn/sqladmin_v1beta4.projects.instances.html
index 300b024afb2..04223e1ae88 100644
--- a/docs/dyn/sqladmin_v1beta4.projects.instances.html
+++ b/docs/dyn/sqladmin_v1beta4.projects.instances.html
@@ -294,6 +294,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -455,6 +468,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -612,6 +638,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -782,6 +821,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
diff --git a/docs/dyn/sqladmin_v1beta4.sslCerts.html b/docs/dyn/sqladmin_v1beta4.sslCerts.html
index eedb16a74ea..32e926b0df0 100644
--- a/docs/dyn/sqladmin_v1beta4.sslCerts.html
+++ b/docs/dyn/sqladmin_v1beta4.sslCerts.html
@@ -273,6 +273,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -476,6 +489,19 @@ 
Method Details

     "kind": "A String", # This is always `sql#operation`.
     "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
     "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+    "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+      "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+      "preCheckResponse": [ # Output only. The responses from the precheck operation.
+        { # Structured PreCheckResponse containing message, type, and required actions.
+          "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+            "A String",
+          ],
+          "message": "A String", # The message to be displayed to the user.
+          "messageType": "A String", # The type of message whether it is an info, warning, or error.
+        },
+      ],
+      "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+    },
     "selfLink": "A String", # The URI of this resource.
     "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
     "status": "A String", # The status of an operation.
diff --git a/docs/dyn/sqladmin_v1beta4.users.html b/docs/dyn/sqladmin_v1beta4.users.html
index b0fa46522fb..8a55727ae9c 100644
--- a/docs/dyn/sqladmin_v1beta4.users.html
+++ b/docs/dyn/sqladmin_v1beta4.users.html
@@ -238,6 +238,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -468,6 +481,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
@@ -704,6 +730,19 @@ 
Method Details

   "kind": "A String", # This is always `sql#operation`.
   "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
   "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
   "selfLink": "A String", # The URI of this resource.
   "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
   "status": "A String", # The status of an operation.
diff --git a/googleapiclient/discovery_cache/documents/sqladmin.v1.json b/googleapiclient/discovery_cache/documents/sqladmin.v1.json
index a10aa2b4002..f2a899d4951 100644
--- a/googleapiclient/discovery_cache/documents/sqladmin.v1.json
+++ b/googleapiclient/discovery_cache/documents/sqladmin.v1.json
@@ -17,7 +17,7 @@
 "canonicalName": "SQL Admin",
 "description": "API for Cloud SQL database instance management",
 "discoveryVersion": "v1",
-"documentationLink": "https://developers.google.com/cloud-sql/",
+"documentationLink": "https://cloud.google.com/sql/docs",
 "fullyEncodeReservedExpansion": true,
 "icons": {
 "x16": "http://www.google.com/images/icons/product/search-16.gif",
@@ -1445,6 +1445,41 @@
 "https://www.googleapis.com/auth/sqlservice.admin"
 ]
 },
+"preCheckMajorVersionUpgrade": {
+"description": "Execute MVU Pre-checks",
+"flatPath": "v1/projects/{project}/instances/{instance}/preCheckMajorVersionUpgrade",
+"httpMethod": "POST",
+"id": "sql.instances.preCheckMajorVersionUpgrade",
+"parameterOrder": [
+"project",
+"instance"
+],
+"parameters": {
+"instance": {
+"description": "Required. Cloud SQL instance ID. This does not include the project ID.",
+"location": "path",
+"required": true,
+"type": "string"
+},
+"project": {
+"description": "Required. Project ID of the project that contains the instance.",
+"location": "path",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/projects/{project}/instances/{instance}/preCheckMajorVersionUpgrade",
+"request": {
+"$ref": "InstancesPreCheckMajorVersionUpgradeRequest"
+},
+"response": {
+"$ref": "Operation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/sqlservice.admin"
+]
+},
 "promoteReplica": {
 "description": "Promotes the read replica instance to be an independent Cloud SQL primary instance. Using this operation might cause your instance to restart.",
 "flatPath": "v1/projects/{project}/instances/{instance}/promoteReplica",
@@ -2650,7 +2685,7 @@
 }
 }
 },
-"revision": "20250908",
+"revision": "20250925",
 "rootUrl": "https://sqladmin.googleapis.com/",
 "schemas": {
 "AclEntry": {
@@ -2838,6 +2873,7 @@
 "POSTGRES_15",
 "POSTGRES_16",
 "POSTGRES_17",
+"POSTGRES_18",
 "SQLSERVER_2019_STANDARD",
 "SQLSERVER_2019_ENTERPRISE",
 "SQLSERVER_2019_EXPRESS",
@@ -2896,6 +2932,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -2940,6 +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 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.",
@@ -3297,6 +3335,7 @@ false
 "POSTGRES_15",
 "POSTGRES_16",
 "POSTGRES_17",
+"POSTGRES_18",
 "SQLSERVER_2019_STANDARD",
 "SQLSERVER_2019_ENTERPRISE",
 "SQLSERVER_2019_EXPRESS",
@@ -3355,6 +3394,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -3399,6 +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 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.",
@@ -3743,6 +3784,7 @@ false
 "POSTGRES_15",
 "POSTGRES_16",
 "POSTGRES_17",
+"POSTGRES_18",
 "SQLSERVER_2019_STANDARD",
 "SQLSERVER_2019_ENTERPRISE",
 "SQLSERVER_2019_EXPRESS",
@@ -3801,6 +3843,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -3845,6 +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 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.",
@@ -4145,6 +4189,7 @@ false
 "POSTGRES_15",
 "POSTGRES_16",
 "POSTGRES_17",
+"POSTGRES_18",
 "SQLSERVER_2019_STANDARD",
 "SQLSERVER_2019_ENTERPRISE",
 "SQLSERVER_2019_EXPRESS",
@@ -4203,6 +4248,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -4247,6 +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 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.",
@@ -5095,6 +5142,7 @@ false
 "POSTGRES_15",
 "POSTGRES_16",
 "POSTGRES_17",
+"POSTGRES_18",
 "SQLSERVER_2019_STANDARD",
 "SQLSERVER_2019_ENTERPRISE",
 "SQLSERVER_2019_EXPRESS",
@@ -5153,6 +5201,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -5197,6 +5246,7 @@ false
 "The database version is PostgreSQL 15.",
 "The database version is PostgreSQL 16.",
 "The database version is PostgreSQL 17.",
+"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.",
@@ -5770,6 +5820,17 @@ false
 },
 "type": "object"
 },
+"InstancesPreCheckMajorVersionUpgradeRequest": {
+"description": "Request for Pre-checks for MVU",
+"id": "InstancesPreCheckMajorVersionUpgradeRequest",
+"properties": {
+"preCheckMajorVersionUpgradeContext": {
+"$ref": "PreCheckMajorVersionUpgradeContext",
+"description": "Required. Contains details about the pre-check major version upgrade operation."
+}
+},
+"type": "object"
+},
 "InstancesReencryptRequest": {
 "description": "Database Instance reencrypt request.",
 "id": "InstancesReencryptRequest",
@@ -6434,6 +6495,10 @@ false
 ],
 "type": "string"
 },
+"preCheckMajorVersionUpgradeContext": {
+"$ref": "PreCheckMajorVersionUpgradeContext",
+"description": "This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found)."
+},
 "selfLink": {
 "description": "The URI of this resource.",
 "type": "string"
@@ -6771,6 +6836,219 @@ false
 },
 "type": "object"
 },
+"PreCheckMajorVersionUpgradeContext": {
+"description": "Pre-check major version upgrade context.",
+"id": "PreCheckMajorVersionUpgradeContext",
+"properties": {
+"kind": {
+"description": "Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.",
+"type": "string"
+},
+"preCheckResponse": {
+"description": "Output only. The responses from the precheck operation.",
+"items": {
+"$ref": "PreCheckResponse"
+},
+"readOnly": true,
+"type": "array"
+},
+"targetDatabaseVersion": {
+"description": "Required. The target database version to upgrade to.",
+"enum": [
+"SQL_DATABASE_VERSION_UNSPECIFIED",
+"MYSQL_5_1",
+"MYSQL_5_5",
+"MYSQL_5_6",
+"MYSQL_5_7",
+"MYSQL_8_0",
+"MYSQL_8_0_18",
+"MYSQL_8_0_26",
+"MYSQL_8_0_27",
+"MYSQL_8_0_28",
+"MYSQL_8_0_29",
+"MYSQL_8_0_30",
+"MYSQL_8_0_31",
+"MYSQL_8_0_32",
+"MYSQL_8_0_33",
+"MYSQL_8_0_34",
+"MYSQL_8_0_35",
+"MYSQL_8_0_36",
+"MYSQL_8_0_37",
+"MYSQL_8_0_39",
+"MYSQL_8_0_40",
+"MYSQL_8_0_41",
+"MYSQL_8_0_42",
+"MYSQL_8_0_43",
+"MYSQL_8_0_44",
+"MYSQL_8_0_45",
+"MYSQL_8_0_46",
+"MYSQL_8_4",
+"SQLSERVER_2017_STANDARD",
+"SQLSERVER_2017_ENTERPRISE",
+"SQLSERVER_2017_EXPRESS",
+"SQLSERVER_2017_WEB",
+"POSTGRES_9_6",
+"POSTGRES_10",
+"POSTGRES_11",
+"POSTGRES_12",
+"POSTGRES_13",
+"POSTGRES_14",
+"POSTGRES_15",
+"POSTGRES_16",
+"POSTGRES_17",
+"POSTGRES_18",
+"SQLSERVER_2019_STANDARD",
+"SQLSERVER_2019_ENTERPRISE",
+"SQLSERVER_2019_EXPRESS",
+"SQLSERVER_2019_WEB",
+"SQLSERVER_2022_STANDARD",
+"SQLSERVER_2022_ENTERPRISE",
+"SQLSERVER_2022_EXPRESS",
+"SQLSERVER_2022_WEB"
+],
+"enumDeprecated": [
+false,
+true,
+true,
+false,
+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,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false
+],
+"enumDescriptions": [
+"This is an unknown database version.",
+"The database version is MySQL 5.1.",
+"The database version is MySQL 5.5.",
+"The database version is MySQL 5.6.",
+"The database version is MySQL 5.7.",
+"The database version is MySQL 8.",
+"The database major version is MySQL 8.0 and the minor version is 18.",
+"The database major version is MySQL 8.0 and the minor version is 26.",
+"The database major version is MySQL 8.0 and the minor version is 27.",
+"The database major version is MySQL 8.0 and the minor version is 28.",
+"The database major version is MySQL 8.0 and the minor version is 29.",
+"The database major version is MySQL 8.0 and the minor version is 30.",
+"The database major version is MySQL 8.0 and the minor version is 31.",
+"The database major version is MySQL 8.0 and the minor version is 32.",
+"The database major version is MySQL 8.0 and the minor version is 33.",
+"The database major version is MySQL 8.0 and the minor version is 34.",
+"The database major version is MySQL 8.0 and the minor version is 35.",
+"The database major version is MySQL 8.0 and the minor version is 36.",
+"The database major version is MySQL 8.0 and the minor version is 37.",
+"The database major version is MySQL 8.0 and the minor version is 39.",
+"The database major version is MySQL 8.0 and the minor version is 40.",
+"The database major version is MySQL 8.0 and the minor version is 41.",
+"The database major version is MySQL 8.0 and the minor version is 42.",
+"The database major version is MySQL 8.0 and the minor version is 43.",
+"The database major version is MySQL 8.0 and the minor version is 44.",
+"The database major version is MySQL 8.0 and the minor version is 45.",
+"The database major version is MySQL 8.0 and the minor version is 46.",
+"The database version is MySQL 8.4.",
+"The database version is SQL Server 2017 Standard.",
+"The database version is SQL Server 2017 Enterprise.",
+"The database version is SQL Server 2017 Express.",
+"The database version is SQL Server 2017 Web.",
+"The database version is PostgreSQL 9.6.",
+"The database version is PostgreSQL 10.",
+"The database version is PostgreSQL 11.",
+"The database version is PostgreSQL 12.",
+"The database version is PostgreSQL 13.",
+"The database version is PostgreSQL 14.",
+"The database version is PostgreSQL 15.",
+"The database version is PostgreSQL 16.",
+"The database version is PostgreSQL 17.",
+"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.",
+"The database version is SQL Server 2019 Web.",
+"The database version is SQL Server 2022 Standard.",
+"The database version is SQL Server 2022 Enterprise.",
+"The database version is SQL Server 2022 Express.",
+"The database version is SQL Server 2022 Web."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
+"PreCheckResponse": {
+"description": "Structured PreCheckResponse containing message, type, and required actions.",
+"id": "PreCheckResponse",
+"properties": {
+"actionsRequired": {
+"description": "The actions that the user needs to take. Use repeated for multiple actions.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
+"message": {
+"description": "The message to be displayed to the user.",
+"type": "string"
+},
+"messageType": {
+"description": "The type of message whether it is an info, warning, or error.",
+"enum": [
+"MESSAGE_TYPE_UNSPECIFIED",
+"INFO",
+"WARNING",
+"ERROR"
+],
+"enumDescriptions": [
+"Default unspecified value to prevent unintended behavior changes.",
+"General informational messages that don't require action.",
+"Warnings that might impact the upgrade but don't block it.",
+"Errors that a user must resolve before proceeding with the upgrade."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
 "PscAutoConnectionConfig": {
 "description": "Settings for an automatically-setup Private Service Connect consumer endpoint that is used to connect to a Cloud SQL instance.",
 "id": "PscAutoConnectionConfig",
@@ -6878,6 +7156,16 @@ false
 "format": "int32",
 "type": "integer"
 },
+"scaleInCooldownSeconds": {
+"description": "The cooldown period for scale-in operations.",
+"format": "int32",
+"type": "integer"
+},
+"scaleOutCooldownSeconds": {
+"description": "The cooldown period for scale-out operations.",
+"format": "int32",
+"type": "integer"
+},
 "targetMetrics": {
 "description": "Optional. Target metrics for read pool auto scaling.",
 "items": {
diff --git a/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json b/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json
index 78b56a7a2fe..b04d1ec8d33 100644
--- a/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json
+++ b/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json
@@ -17,7 +17,7 @@
 "canonicalName": "SQL Admin",
 "description": "API for Cloud SQL database instance management",
 "discoveryVersion": "v1",
-"documentationLink": "https://developers.google.com/cloud-sql/",
+"documentationLink": "https://cloud.google.com/sql/docs",
 "fullyEncodeReservedExpansion": true,
 "icons": {
 "x16": "http://www.google.com/images/icons/product/search-16.gif",
@@ -1445,6 +1445,41 @@
 "https://www.googleapis.com/auth/sqlservice.admin"
 ]
 },
+"preCheckMajorVersionUpgrade": {
+"description": "Execute MVU Pre-checks",
+"flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/preCheckMajorVersionUpgrade",
+"httpMethod": "POST",
+"id": "sql.instances.preCheckMajorVersionUpgrade",
+"parameterOrder": [
+"project",
+"instance"
+],
+"parameters": {
+"instance": {
+"description": "Required. Cloud SQL instance ID. This does not include the project ID.",
+"location": "path",
+"required": true,
+"type": "string"
+},
+"project": {
+"description": "Required. Project ID of the project that contains the instance.",
+"location": "path",
+"required": true,
+"type": "string"
+}
+},
+"path": "sql/v1beta4/projects/{project}/instances/{instance}/preCheckMajorVersionUpgrade",
+"request": {
+"$ref": "InstancesPreCheckMajorVersionUpgradeRequest"
+},
+"response": {
+"$ref": "Operation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/sqlservice.admin"
+]
+},
 "promoteReplica": {
 "description": "Promotes the read replica instance to be an independent Cloud SQL primary instance. Using this operation might cause your instance to restart.",
 "flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/promoteReplica",
@@ -1875,7 +1910,7 @@
 "operations": {
 "methods": {
 "cancel": {
-"description": "Cancels an instance operation that has been performed on an instance.",
+"description": "Cancels an instance operation that has been performed on an instance. Ordinarily, this method name should be `CancelSqlOperation`.",
 "flatPath": "sql/v1beta4/projects/{project}/operations/{operation}/cancel",
 "httpMethod": "POST",
 "id": "sql.operations.cancel",
@@ -2650,7 +2685,7 @@
 }
 }
 },
-"revision": "20250908",
+"revision": "20250925",
 "rootUrl": "https://sqladmin.googleapis.com/",
 "schemas": {
 "AclEntry": {
@@ -2838,6 +2873,7 @@
 "POSTGRES_15",
 "POSTGRES_16",
 "POSTGRES_17",
+"POSTGRES_18",
 "SQLSERVER_2019_STANDARD",
 "SQLSERVER_2019_ENTERPRISE",
 "SQLSERVER_2019_EXPRESS",
@@ -2896,6 +2932,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -2940,6 +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 SQL Server 2019 Standard.",
 "The database version is SQL Server 2019 Enterprise.",
 "The database version is SQL Server 2019 Express.",
@@ -3297,6 +3335,7 @@ false
 "POSTGRES_15",
 "POSTGRES_16",
 "POSTGRES_17",
+"POSTGRES_18",
 "SQLSERVER_2019_STANDARD",
 "SQLSERVER_2019_ENTERPRISE",
 "SQLSERVER_2019_EXPRESS",
@@ -3355,6 +3394,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -3399,6 +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 SQL Server 2019 Standard.",
 "The database version is SQL Server 2019 Enterprise.",
 "The database version is SQL Server 2019 Express.",
@@ -3743,6 +3784,7 @@ false
 "POSTGRES_15",
 "POSTGRES_16",
 "POSTGRES_17",
+"POSTGRES_18",
 "SQLSERVER_2019_STANDARD",
 "SQLSERVER_2019_ENTERPRISE",
 "SQLSERVER_2019_EXPRESS",
@@ -3801,6 +3843,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -3845,6 +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 SQL Server 2019 Standard.",
 "The database version is SQL Server 2019 Enterprise.",
 "The database version is SQL Server 2019 Express.",
@@ -4145,6 +4189,7 @@ false
 "POSTGRES_15",
 "POSTGRES_16",
 "POSTGRES_17",
+"POSTGRES_18",
 "SQLSERVER_2019_STANDARD",
 "SQLSERVER_2019_ENTERPRISE",
 "SQLSERVER_2019_EXPRESS",
@@ -4203,6 +4248,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -4247,6 +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 SQL Server 2019 Standard.",
 "The database version is SQL Server 2019 Enterprise.",
 "The database version is SQL Server 2019 Express.",
@@ -5096,6 +5143,7 @@ false
 "POSTGRES_15",
 "POSTGRES_16",
 "POSTGRES_17",
+"POSTGRES_18",
 "SQLSERVER_2019_STANDARD",
 "SQLSERVER_2019_ENTERPRISE",
 "SQLSERVER_2019_EXPRESS",
@@ -5154,6 +5202,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -5198,6 +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 SQL Server 2019 Standard.",
 "The database version is SQL Server 2019 Enterprise.",
 "The database version is SQL Server 2019 Express.",
@@ -5771,6 +5821,17 @@ false
 },
 "type": "object"
 },
+"InstancesPreCheckMajorVersionUpgradeRequest": {
+"description": "Request for Pre-checks for MVU",
+"id": "InstancesPreCheckMajorVersionUpgradeRequest",
+"properties": {
+"preCheckMajorVersionUpgradeContext": {
+"$ref": "PreCheckMajorVersionUpgradeContext",
+"description": "Required. Contains details about the pre-check major version upgrade operation."
+}
+},
+"type": "object"
+},
 "InstancesReencryptRequest": {
 "description": "Database Instance reencrypt request.",
 "id": "InstancesReencryptRequest",
@@ -6435,6 +6496,10 @@ false
 ],
 "type": "string"
 },
+"preCheckMajorVersionUpgradeContext": {
+"$ref": "PreCheckMajorVersionUpgradeContext",
+"description": "The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found)."
+},
 "selfLink": {
 "description": "The URI of this resource.",
 "type": "string"
@@ -6772,6 +6837,219 @@ false
 },
 "type": "object"
 },
+"PreCheckMajorVersionUpgradeContext": {
+"description": "Pre-check major version upgrade context.",
+"id": "PreCheckMajorVersionUpgradeContext",
+"properties": {
+"kind": {
+"description": "Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.",
+"type": "string"
+},
+"preCheckResponse": {
+"description": "Output only. The responses from the precheck operation.",
+"items": {
+"$ref": "PreCheckResponse"
+},
+"readOnly": true,
+"type": "array"
+},
+"targetDatabaseVersion": {
+"description": "Required. The target database version to upgrade to.",
+"enum": [
+"SQL_DATABASE_VERSION_UNSPECIFIED",
+"MYSQL_5_1",
+"MYSQL_5_5",
+"MYSQL_5_6",
+"MYSQL_5_7",
+"MYSQL_8_0",
+"MYSQL_8_0_18",
+"MYSQL_8_0_26",
+"MYSQL_8_0_27",
+"MYSQL_8_0_28",
+"MYSQL_8_0_29",
+"MYSQL_8_0_30",
+"MYSQL_8_0_31",
+"MYSQL_8_0_32",
+"MYSQL_8_0_33",
+"MYSQL_8_0_34",
+"MYSQL_8_0_35",
+"MYSQL_8_0_36",
+"MYSQL_8_0_37",
+"MYSQL_8_0_39",
+"MYSQL_8_0_40",
+"MYSQL_8_0_41",
+"MYSQL_8_0_42",
+"MYSQL_8_0_43",
+"MYSQL_8_0_44",
+"MYSQL_8_0_45",
+"MYSQL_8_0_46",
+"MYSQL_8_4",
+"SQLSERVER_2017_STANDARD",
+"SQLSERVER_2017_ENTERPRISE",
+"SQLSERVER_2017_EXPRESS",
+"SQLSERVER_2017_WEB",
+"POSTGRES_9_6",
+"POSTGRES_10",
+"POSTGRES_11",
+"POSTGRES_12",
+"POSTGRES_13",
+"POSTGRES_14",
+"POSTGRES_15",
+"POSTGRES_16",
+"POSTGRES_17",
+"POSTGRES_18",
+"SQLSERVER_2019_STANDARD",
+"SQLSERVER_2019_ENTERPRISE",
+"SQLSERVER_2019_EXPRESS",
+"SQLSERVER_2019_WEB",
+"SQLSERVER_2022_STANDARD",
+"SQLSERVER_2022_ENTERPRISE",
+"SQLSERVER_2022_EXPRESS",
+"SQLSERVER_2022_WEB"
+],
+"enumDeprecated": [
+false,
+true,
+true,
+false,
+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,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false
+],
+"enumDescriptions": [
+"This is an unknown database version.",
+"The database version is MySQL 5.1.",
+"The database version is MySQL 5.5.",
+"The database version is MySQL 5.6.",
+"The database version is MySQL 5.7.",
+"The database version is MySQL 8.",
+"The database major version is MySQL 8.0 and the minor version is 18.",
+"The database major version is MySQL 8.0 and the minor version is 26.",
+"The database major version is MySQL 8.0 and the minor version is 27.",
+"The database major version is MySQL 8.0 and the minor version is 28.",
+"The database major version is MySQL 8.0 and the minor version is 29.",
+"The database major version is MySQL 8.0 and the minor version is 30.",
+"The database major version is MySQL 8.0 and the minor version is 31.",
+"The database major version is MySQL 8.0 and the minor version is 32.",
+"The database major version is MySQL 8.0 and the minor version is 33.",
+"The database major version is MySQL 8.0 and the minor version is 34.",
+"The database major version is MySQL 8.0 and the minor version is 35.",
+"The database major version is MySQL 8.0 and the minor version is 36.",
+"The database major version is MySQL 8.0 and the minor version is 37.",
+"The database major version is MySQL 8.0 and the minor version is 39.",
+"The database major version is MySQL 8.0 and the minor version is 40.",
+"The database major version is MySQL 8.0 and the minor version is 41.",
+"The database major version is MySQL 8.0 and the minor version is 42.",
+"The database major version is MySQL 8.0 and the minor version is 43.",
+"The database major version is MySQL 8.0 and the minor version is 44.",
+"The database major version is MySQL 8.0 and the minor version is 45.",
+"The database major version is MySQL 8.0 and the minor version is 46.",
+"The database version is MySQL 8.4.",
+"The database version is SQL Server 2017 Standard.",
+"The database version is SQL Server 2017 Enterprise.",
+"The database version is SQL Server 2017 Express.",
+"The database version is SQL Server 2017 Web.",
+"The database version is PostgreSQL 9.6.",
+"The database version is PostgreSQL 10.",
+"The database version is PostgreSQL 11.",
+"The database version is PostgreSQL 12.",
+"The database version is PostgreSQL 13.",
+"The database version is PostgreSQL 14.",
+"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 SQL Server 2019 Standard.",
+"The database version is SQL Server 2019 Enterprise.",
+"The database version is SQL Server 2019 Express.",
+"The database version is SQL Server 2019 Web.",
+"The database version is SQL Server 2022 Standard.",
+"The database version is SQL Server 2022 Enterprise.",
+"The database version is SQL Server 2022 Express.",
+"The database version is SQL Server 2022 Web."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
+"PreCheckResponse": {
+"description": "Structured PreCheckResponse containing message, type, and required actions.",
+"id": "PreCheckResponse",
+"properties": {
+"actionsRequired": {
+"description": "The actions that the user needs to take. Use repeated for multiple actions.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
+"message": {
+"description": "The message to be displayed to the user.",
+"type": "string"
+},
+"messageType": {
+"description": "The type of message whether it is an info, warning, or error.",
+"enum": [
+"MESSAGE_TYPE_UNSPECIFIED",
+"INFO",
+"WARNING",
+"ERROR"
+],
+"enumDescriptions": [
+"Default unspecified value to prevent unintended behavior changes.",
+"General informational messages that don't require action.",
+"Warnings that might impact the upgrade but don't block it.",
+"Errors that a user must resolve before proceeding with the upgrade."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
 "PscAutoConnectionConfig": {
 "description": "Settings for an automatically-setup Private Service Connect consumer endpoint that is used to connect to a Cloud SQL instance.",
 "id": "PscAutoConnectionConfig",
@@ -6879,6 +7157,16 @@ false
 "format": "int32",
 "type": "integer"
 },
+"scaleInCooldownSeconds": {
+"description": "The cooldown period for scale in operations.",
+"format": "int32",
+"type": "integer"
+},
+"scaleOutCooldownSeconds": {
+"description": "The cooldown period for scale out operations.",
+"format": "int32",
+"type": "integer"
+},
 "targetMetrics": {
 "description": "Optional. Target metrics for read pool auto scaling.",
 "items": {

From 53cb3d9e10219db874e65113448c28dabcee404a Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 30 Sep 2025 07:09:38 +0000
Subject: [PATCH 38/42] feat(storage): update the api

#### storage:v1

The following keys were added:
- resources.buckets.methods.list.parameters.returnPartialSuccess (Total Keys: 2)
- schemas.Buckets.properties.unreachable (Total Keys: 2)
---
 docs/dyn/storage_v1.buckets.html                 |  8 ++++++--
 .../discovery_cache/documents/storage.v1.json    | 16 ++++++++++++++--
 2 files changed, 20 insertions(+), 4 deletions(-)

diff --git a/docs/dyn/storage_v1.buckets.html b/docs/dyn/storage_v1.buckets.html
index 89040c890d7..583987d17c4 100644
--- a/docs/dyn/storage_v1.buckets.html
+++ b/docs/dyn/storage_v1.buckets.html
@@ -93,7 +93,7 @@ 
Instance Methods

   insert(project, body=None, enableObjectRetention=None, predefinedAcl=None, predefinedDefaultObjectAcl=None, projection=None, userProject=None)

 
Creates a new bucket.

 

-  list(project, maxResults=None, pageToken=None, prefix=None, projection=None, softDeleted=None, userProject=None)

+  list(project, maxResults=None, pageToken=None, prefix=None, projection=None, returnPartialSuccess=None, softDeleted=None, userProject=None)

 
Retrieves a list of buckets for a given project.

 

   list_next()

@@ -924,7 +924,7 @@ 
Method Details

 

 
 

-    list(project, maxResults=None, pageToken=None, prefix=None, projection=None, softDeleted=None, userProject=None)
+    list(project, maxResults=None, pageToken=None, prefix=None, projection=None, returnPartialSuccess=None, softDeleted=None, userProject=None)
   
Retrieves a list of buckets for a given project.
 
 Args:
@@ -936,6 +936,7 @@ 
Method Details

     Allowed values
       full - Include all properties.
       noAcl - Omit owner, acl and defaultObjectAcl properties.
+  returnPartialSuccess: boolean, If true, return a list of bucket resource names for buckets that are in unreachable locations.
   softDeleted: boolean, If true, only soft-deleted bucket versions will be returned. The default is false. For more information, see [Soft Delete](https://cloud.google.com/storage/docs/soft-delete).
   userProject: string, The project to be billed for this request.
 
@@ -1163,6 +1164,9 @@ 
Method Details

   ],
   "kind": "storage#buckets", # The kind of item this is. For lists of buckets, this is always storage#buckets.
   "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
+  "unreachable": [ # The list of bucket resource names that could not be reached during the listing operation.
+    "A String",
+  ],
 }

 

 
diff --git a/googleapiclient/discovery_cache/documents/storage.v1.json b/googleapiclient/discovery_cache/documents/storage.v1.json
index d0be656cd74..fcae9e13854 100644
--- a/googleapiclient/discovery_cache/documents/storage.v1.json
+++ b/googleapiclient/discovery_cache/documents/storage.v1.json
@@ -253,7 +253,7 @@
 "location": "northamerica-south1"
 }
 ],
-"etag": "\"3136333632333439343533383832363638313632\"",
+"etag": "\"3131343633323936333034313936343439353533\"",
 "icons": {
 "x16": "https://www.google.com/images/icons/product/cloud_storage-16.png",
 "x32": "https://www.google.com/images/icons/product/cloud_storage-32.png"
@@ -1083,6 +1083,11 @@
 "location": "query",
 "type": "string"
 },
+"returnPartialSuccess": {
+"description": "If true, return a list of bucket resource names for buckets that are in unreachable locations.",
+"location": "query",
+"type": "boolean"
+},
 "softDeleted": {
 "description": "If true, only soft-deleted bucket versions will be returned. The default is false. For more information, see [Soft Delete](https://cloud.google.com/storage/docs/soft-delete).",
 "location": "query",
@@ -4544,7 +4549,7 @@
 }
 }
 },
-"revision": "20250814",
+"revision": "20250925",
 "rootUrl": "https://storage.googleapis.com/",
 "schemas": {
 "AdvanceRelocateBucketOperationRequest": {
@@ -5385,6 +5390,13 @@
 "nextPageToken": {
 "description": "The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.",
 "type": "string"
+},
+"unreachable": {
+"description": "The list of bucket resource names that could not be reached during the listing operation.",
+"items": {
+"type": "string"
+},
+"type": "array"
 }
 },
 "type": "object"

From ff0931d871f06884e6afd093644aa403313d964b Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 30 Sep 2025 07:09:38 +0000
Subject: [PATCH 39/42] feat(texttospeech): update the api

#### texttospeech:v1

The following keys were added:
- schemas.MultiSpeakerVoiceConfig (Total Keys: 4)
- schemas.MultispeakerPrebuiltVoice (Total Keys: 4)
- schemas.VoiceSelectionParams.properties.multiSpeakerVoiceConfig.$ref (Total Keys: 1)

#### texttospeech:v1beta1

The following keys were added:
- schemas.MultiSpeakerVoiceConfig (Total Keys: 4)
- schemas.MultispeakerPrebuiltVoice (Total Keys: 4)
- schemas.VoiceSelectionParams.properties.multiSpeakerVoiceConfig.$ref (Total Keys: 1)
---
 .../texttospeech_v1.projects.locations.html   |  8 +++++
 docs/dyn/texttospeech_v1.text.html            |  8 +++++
 ...xttospeech_v1beta1.projects.locations.html |  8 +++++
 docs/dyn/texttospeech_v1beta1.text.html       |  8 +++++
 .../documents/texttospeech.v1.json            | 35 ++++++++++++++++++-
 .../documents/texttospeech.v1beta1.json       | 35 ++++++++++++++++++-
 6 files changed, 100 insertions(+), 2 deletions(-)

diff --git a/docs/dyn/texttospeech_v1.projects.locations.html b/docs/dyn/texttospeech_v1.projects.locations.html
index 98f300b2c29..94823a460f4 100644
--- a/docs/dyn/texttospeech_v1.projects.locations.html
+++ b/docs/dyn/texttospeech_v1.projects.locations.html
@@ -142,6 +142,14 @@ 
Method Details

     },
     "languageCode": "A String", # Required. The language (and potentially also the region) of the voice expressed as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag, e.g. "en-US". This should not include a script tag (e.g. use "cmn-cn" rather than "cmn-Hant-cn"), because the script will be inferred from the input provided in the SynthesisInput. The TTS service will use this parameter to help choose an appropriate voice. Note that the TTS service may choose a voice with a slightly different language code than the one selected; it may substitute a different region (e.g. using en-US rather than en-CA if there isn't a Canadian voice available), or even a different language, e.g. using "nb" (Norwegian Bokmal) instead of "no" (Norwegian)".
     "modelName": "A String", # Optional. The name of the model. If set, the service will choose the model matching the specified configuration.
+    "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # Optional. The configuration for a Gemini multi-speaker text-to-speech setup. Enables the use of two distinct voices in a single synthesis request.
+      "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 Gemini TTS multi-speaker setup. Enables dialogue between two speakers.
+          "speakerAlias": "A String", # Required. The speaker alias of the voice. This is the user-chosen speaker name that is used in the multispeaker text input, such as "Speaker1".
+          "speakerId": "A String", # Required. The speaker ID of the voice. See https://cloud.google.com/text-to-speech/docs/gemini-tts#voice_options for available values.
+        },
+      ],
+    },
     "name": "A String", # The name of the voice. If both the name and the gender are not set, the service will choose a voice based on the other parameters such as language_code.
     "ssmlGender": "A String", # The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement; if a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request.
     "voiceClone": { # The configuration of Voice Clone feature. # Optional. The configuration for a voice clone. If [VoiceCloneParams.voice_clone_key] is set, the service chooses the voice clone matching the specified configuration.
diff --git a/docs/dyn/texttospeech_v1.text.html b/docs/dyn/texttospeech_v1.text.html
index 102511ae81c..68a0f9f462e 100644
--- a/docs/dyn/texttospeech_v1.text.html
+++ b/docs/dyn/texttospeech_v1.text.html
@@ -138,6 +138,14 @@ 
Method Details

     },
     "languageCode": "A String", # Required. The language (and potentially also the region) of the voice expressed as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag, e.g. "en-US". This should not include a script tag (e.g. use "cmn-cn" rather than "cmn-Hant-cn"), because the script will be inferred from the input provided in the SynthesisInput. The TTS service will use this parameter to help choose an appropriate voice. Note that the TTS service may choose a voice with a slightly different language code than the one selected; it may substitute a different region (e.g. using en-US rather than en-CA if there isn't a Canadian voice available), or even a different language, e.g. using "nb" (Norwegian Bokmal) instead of "no" (Norwegian)".
     "modelName": "A String", # Optional. The name of the model. If set, the service will choose the model matching the specified configuration.
+    "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # Optional. The configuration for a Gemini multi-speaker text-to-speech setup. Enables the use of two distinct voices in a single synthesis request.
+      "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 Gemini TTS multi-speaker setup. Enables dialogue between two speakers.
+          "speakerAlias": "A String", # Required. The speaker alias of the voice. This is the user-chosen speaker name that is used in the multispeaker text input, such as "Speaker1".
+          "speakerId": "A String", # Required. The speaker ID of the voice. See https://cloud.google.com/text-to-speech/docs/gemini-tts#voice_options for available values.
+        },
+      ],
+    },
     "name": "A String", # The name of the voice. If both the name and the gender are not set, the service will choose a voice based on the other parameters such as language_code.
     "ssmlGender": "A String", # The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement; if a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request.
     "voiceClone": { # The configuration of Voice Clone feature. # Optional. The configuration for a voice clone. If [VoiceCloneParams.voice_clone_key] is set, the service chooses the voice clone matching the specified configuration.
diff --git a/docs/dyn/texttospeech_v1beta1.projects.locations.html b/docs/dyn/texttospeech_v1beta1.projects.locations.html
index 68ef1a362b6..00e26b43254 100644
--- a/docs/dyn/texttospeech_v1beta1.projects.locations.html
+++ b/docs/dyn/texttospeech_v1beta1.projects.locations.html
@@ -142,6 +142,14 @@ 
Method Details

     },
     "languageCode": "A String", # Required. The language (and potentially also the region) of the voice expressed as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag, e.g. "en-US". This should not include a script tag (e.g. use "cmn-cn" rather than "cmn-Hant-cn"), because the script will be inferred from the input provided in the SynthesisInput. The TTS service will use this parameter to help choose an appropriate voice. Note that the TTS service may choose a voice with a slightly different language code than the one selected; it may substitute a different region (e.g. using en-US rather than en-CA if there isn't a Canadian voice available), or even a different language, e.g. using "nb" (Norwegian Bokmal) instead of "no" (Norwegian)".
     "modelName": "A String", # Optional. The name of the model. If set, the service will choose the model matching the specified configuration.
+    "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # Optional. The configuration for a Gemini multi-speaker text-to-speech setup. Enables the use of two distinct voices in a single synthesis request.
+      "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 Gemini TTS multi-speaker setup. Enables dialogue between two speakers.
+          "speakerAlias": "A String", # Required. The speaker alias of the voice. This is the user-chosen speaker name that is used in the multispeaker text input, such as "Speaker1".
+          "speakerId": "A String", # Required. The speaker ID of the voice. See https://cloud.google.com/text-to-speech/docs/gemini-tts#voice_options for available values.
+        },
+      ],
+    },
     "name": "A String", # The name of the voice. If both the name and the gender are not set, the service will choose a voice based on the other parameters such as language_code.
     "ssmlGender": "A String", # The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement; if a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request.
     "voiceClone": { # The configuration of Voice Clone feature. # Optional. The configuration for a voice clone. If [VoiceCloneParams.voice_clone_key] is set, the service chooses the voice clone matching the specified configuration.
diff --git a/docs/dyn/texttospeech_v1beta1.text.html b/docs/dyn/texttospeech_v1beta1.text.html
index c87ddb2ffa5..9dfe0039081 100644
--- a/docs/dyn/texttospeech_v1beta1.text.html
+++ b/docs/dyn/texttospeech_v1beta1.text.html
@@ -141,6 +141,14 @@ 
Method Details

     },
     "languageCode": "A String", # Required. The language (and potentially also the region) of the voice expressed as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag, e.g. "en-US". This should not include a script tag (e.g. use "cmn-cn" rather than "cmn-Hant-cn"), because the script will be inferred from the input provided in the SynthesisInput. The TTS service will use this parameter to help choose an appropriate voice. Note that the TTS service may choose a voice with a slightly different language code than the one selected; it may substitute a different region (e.g. using en-US rather than en-CA if there isn't a Canadian voice available), or even a different language, e.g. using "nb" (Norwegian Bokmal) instead of "no" (Norwegian)".
     "modelName": "A String", # Optional. The name of the model. If set, the service will choose the model matching the specified configuration.
+    "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # Optional. The configuration for a Gemini multi-speaker text-to-speech setup. Enables the use of two distinct voices in a single synthesis request.
+      "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 Gemini TTS multi-speaker setup. Enables dialogue between two speakers.
+          "speakerAlias": "A String", # Required. The speaker alias of the voice. This is the user-chosen speaker name that is used in the multispeaker text input, such as "Speaker1".
+          "speakerId": "A String", # Required. The speaker ID of the voice. See https://cloud.google.com/text-to-speech/docs/gemini-tts#voice_options for available values.
+        },
+      ],
+    },
     "name": "A String", # The name of the voice. If both the name and the gender are not set, the service will choose a voice based on the other parameters such as language_code.
     "ssmlGender": "A String", # The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement; if a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request.
     "voiceClone": { # The configuration of Voice Clone feature. # Optional. The configuration for a voice clone. If [VoiceCloneParams.voice_clone_key] is set, the service chooses the voice clone matching the specified configuration.
diff --git a/googleapiclient/discovery_cache/documents/texttospeech.v1.json b/googleapiclient/discovery_cache/documents/texttospeech.v1.json
index 986c9db9129..faabfd3a464 100644
--- a/googleapiclient/discovery_cache/documents/texttospeech.v1.json
+++ b/googleapiclient/discovery_cache/documents/texttospeech.v1.json
@@ -318,7 +318,7 @@
 }
 }
 },
-"revision": "20250912",
+"revision": "20250923",
 "rootUrl": "https://texttospeech.googleapis.com/",
 "schemas": {
 "AdvancedVoiceOptions": {
@@ -544,6 +544,35 @@
 },
 "type": "object"
 },
+"MultiSpeakerVoiceConfig": {
+"description": "Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request.",
+"id": "MultiSpeakerVoiceConfig",
+"properties": {
+"speakerVoiceConfigs": {
+"description": "Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.",
+"items": {
+"$ref": "MultispeakerPrebuiltVoice"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"MultispeakerPrebuiltVoice": {
+"description": "Configuration for a single speaker in a Gemini TTS multi-speaker setup. Enables dialogue between two speakers.",
+"id": "MultispeakerPrebuiltVoice",
+"properties": {
+"speakerAlias": {
+"description": "Required. The speaker alias of the voice. This is the user-chosen speaker name that is used in the multispeaker text input, such as \"Speaker1\".",
+"type": "string"
+},
+"speakerId": {
+"description": "Required. The speaker ID of the voice. See https://cloud.google.com/text-to-speech/docs/gemini-tts#voice_options for available values.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "Operation": {
 "description": "This resource represents a long-running operation that is the result of a network API call.",
 "id": "Operation",
@@ -799,6 +828,10 @@
 "description": "Optional. The name of the model. If set, the service will choose the model matching the specified configuration.",
 "type": "string"
 },
+"multiSpeakerVoiceConfig": {
+"$ref": "MultiSpeakerVoiceConfig",
+"description": "Optional. The configuration for a Gemini multi-speaker text-to-speech setup. Enables the use of two distinct voices in a single synthesis request."
+},
 "name": {
 "description": "The name of the voice. If both the name and the gender are not set, the service will choose a voice based on the other parameters such as language_code.",
 "type": "string"
diff --git a/googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json b/googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json
index 72c40a2601e..2f8495ccc75 100644
--- a/googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json
@@ -261,7 +261,7 @@
 }
 }
 },
-"revision": "20250912",
+"revision": "20250923",
 "rootUrl": "https://texttospeech.googleapis.com/",
 "schemas": {
 "AdvancedVoiceOptions": {
@@ -477,6 +477,35 @@
 },
 "type": "object"
 },
+"MultiSpeakerVoiceConfig": {
+"description": "Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request.",
+"id": "MultiSpeakerVoiceConfig",
+"properties": {
+"speakerVoiceConfigs": {
+"description": "Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.",
+"items": {
+"$ref": "MultispeakerPrebuiltVoice"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"MultispeakerPrebuiltVoice": {
+"description": "Configuration for a single speaker in a Gemini TTS multi-speaker setup. Enables dialogue between two speakers.",
+"id": "MultispeakerPrebuiltVoice",
+"properties": {
+"speakerAlias": {
+"description": "Required. The speaker alias of the voice. This is the user-chosen speaker name that is used in the multispeaker text input, such as \"Speaker1\".",
+"type": "string"
+},
+"speakerId": {
+"description": "Required. The speaker ID of the voice. See https://cloud.google.com/text-to-speech/docs/gemini-tts#voice_options for available values.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "Operation": {
 "description": "This resource represents a long-running operation that is the result of a network API call.",
 "id": "Operation",
@@ -774,6 +803,10 @@
 "description": "Optional. The name of the model. If set, the service will choose the model matching the specified configuration.",
 "type": "string"
 },
+"multiSpeakerVoiceConfig": {
+"$ref": "MultiSpeakerVoiceConfig",
+"description": "Optional. The configuration for a Gemini multi-speaker text-to-speech setup. Enables the use of two distinct voices in a single synthesis request."
+},
 "name": {
 "description": "The name of the voice. If both the name and the gender are not set, the service will choose a voice based on the other parameters such as language_code.",
 "type": "string"

From 4254558da3975611ece872d592eb104bf091acb5 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 30 Sep 2025 07:09:38 +0000
Subject: [PATCH 40/42] feat(tpu): update the api

#### tpu:v2alpha1

The following keys were added:
- resources.projects.resources.locations.resources.queuedResources.methods.getMaintenanceInfo (Total Keys: 11)
- schemas.GetMaintenanceInfoResponse (Total Keys: 4)
- schemas.NodeUpcomingMaintenanceInfo (Total Keys: 6)
---
 ...a1.projects.locations.queuedResources.html | 35 +++++++++++
 .../documents/tpu.v2alpha1.json               | 61 ++++++++++++++++++-
 2 files changed, 95 insertions(+), 1 deletion(-)

diff --git a/docs/dyn/tpu_v2alpha1.projects.locations.queuedResources.html b/docs/dyn/tpu_v2alpha1.projects.locations.queuedResources.html
index 2460f0ad1a5..5db40708e7e 100644
--- a/docs/dyn/tpu_v2alpha1.projects.locations.queuedResources.html
+++ b/docs/dyn/tpu_v2alpha1.projects.locations.queuedResources.html
@@ -86,6 +86,9 @@ 
Instance Methods

 

   get(name, x__xgafv=None)

 
Gets details of a queued resource.

+

+  getMaintenanceInfo(name, x__xgafv=None)

+
Gets the maintenance info for a queued resource.

 

   list(parent, pageSize=None, pageToken=None, x__xgafv=None)

 
Lists queued resources.

@@ -552,6 +555,38 @@ 
Method Details

 }
+
+ getMaintenanceInfo(name, x__xgafv=None) + 
Gets the maintenance info for a queued resource.
+
+Args:
+  name: string, Required. The QueuedResource name. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for GetMaintenanceInfo.
+  "nodeUpcomingMaintenances": [ # The list of upcoming maintenance entries.
+    { # A tuple containing node name / ID and maintenance info.
+      "nodeName": "A String", # Unqualified node name.
+      "nodeUid": "A String", # UID of this node.
+      "upcomingMaintenance": { # Upcoming Maintenance notification information. # Upcoming maintenance info for this node.
+        "canReschedule": True or False, # Indicates if the maintenance can be customer triggered.
+        "latestWindowStartTime": "A String", # The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format.
+        "maintenanceStatus": "A String", # The status of the maintenance.
+        "type": "A String", # Defines the type of maintenance.
+        "windowEndTime": "A String", # The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format.
+        "windowStartTime": "A String", # The current start time of the maintenance window. This timestamp value is in RFC3339 text format.
+      },
+    },
+  ],
+}
+
+
list(parent, pageSize=None, pageToken=None, x__xgafv=None) 
Lists queued resources.
diff --git a/googleapiclient/discovery_cache/documents/tpu.v2alpha1.json b/googleapiclient/discovery_cache/documents/tpu.v2alpha1.json
index 95db60ae29e..42661438372 100644
--- a/googleapiclient/discovery_cache/documents/tpu.v2alpha1.json
+++ b/googleapiclient/discovery_cache/documents/tpu.v2alpha1.json
@@ -813,6 +813,31 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
+"getMaintenanceInfo": {
+"description": "Gets the maintenance info for a queued resource.",
+"flatPath": "v2alpha1/projects/{projectsId}/locations/{locationsId}/queuedResources/{queuedResourcesId}:getMaintenanceInfo",
+"httpMethod": "GET",
+"id": "tpu.projects.locations.queuedResources.getMaintenanceInfo",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The QueuedResource name.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/queuedResources/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v2alpha1/{+name}:getMaintenanceInfo",
+"response": {
+"$ref": "GetMaintenanceInfoResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "list": {
 "description": "Lists queued resources.",
 "flatPath": "v2alpha1/projects/{projectsId}/locations/{locationsId}/queuedResources",
@@ -1027,7 +1052,7 @@
 }
 }
 },
-"revision": "20250903",
+"revision": "20250918",
 "rootUrl": "https://tpu.googleapis.com/",
 "schemas": {
 "AcceleratorConfig": {
@@ -1274,6 +1299,20 @@
 },
 "type": "object"
 },
+"GetMaintenanceInfoResponse": {
+"description": "Response for GetMaintenanceInfo.",
+"id": "GetMaintenanceInfoResponse",
+"properties": {
+"nodeUpcomingMaintenances": {
+"description": "The list of upcoming maintenance entries.",
+"items": {
+"$ref": "NodeUpcomingMaintenanceInfo"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "Guaranteed": {
 "description": "Guaranteed tier definition.",
 "id": "Guaranteed",
@@ -1859,6 +1898,26 @@
 },
 "type": "object"
 },
+"NodeUpcomingMaintenanceInfo": {
+"description": "A tuple containing node name / ID and maintenance info.",
+"id": "NodeUpcomingMaintenanceInfo",
+"properties": {
+"nodeName": {
+"description": "Unqualified node name.",
+"type": "string"
+},
+"nodeUid": {
+"description": "UID of this node.",
+"format": "int64",
+"type": "string"
+},
+"upcomingMaintenance": {
+"$ref": "UpcomingMaintenance",
+"description": "Upcoming maintenance info for this node."
+}
+},
+"type": "object"
+},
 "Operation": {
 "description": "This resource represents a long-running operation that is the result of a network API call.",
 "id": "Operation",

From ce0f981f1f25630bc2768a697aa8da218c6e6af1 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 30 Sep 2025 07:09:38 +0000
Subject: [PATCH 41/42] feat(webfonts): update the api

#### webfonts:v1

The following keys were added:
- schemas.Tag (Total Keys: 5)
- schemas.Webfont.properties.tags (Total Keys: 2)
---
 docs/dyn/webfonts_v1.webfonts.html            |  7 +++++
 .../documents/webfonts.v1.json                | 31 +++++++++++++++++--
 2 files changed, 35 insertions(+), 3 deletions(-)

diff --git a/docs/dyn/webfonts_v1.webfonts.html b/docs/dyn/webfonts_v1.webfonts.html
index bb1513603f4..716dd8a5016 100644
--- a/docs/dyn/webfonts_v1.webfonts.html
+++ b/docs/dyn/webfonts_v1.webfonts.html
@@ -96,6 +96,7 @@ 
Method Details

       CAPABILITY_UNSPECIFIED - Default means static ttf fonts.
       WOFF2 - Use WOFF2(Compressed)instead of ttf.
       VF - Prefer variable font files instead of static fonts instantiated at standard weights.
+      FAMILY_TAGS - Include tags that apply to the entire family in the response.
   category: string, Filters by Webfont.category, if category is found in Webfont.categories. If not set, returns all families.
   family: string, Filters by Webfont.family, using literal match. If not set, returns all families (repeated)
   sort: string, Enables sorting of the list.
@@ -139,6 +140,12 @@ 
Method Details

       "subsets": [ # The scripts supported by the font.
         "A String",
       ],
+      "tags": [ # The tags that apply to this family.
+        { # Metadata for a tag.
+          "name": "A String", # The name of the tag.
+          "weight": 3.14, # The weight of the tag.
+        },
+      ],
       "variants": [ # The available variants for the font.
         "A String",
       ],
diff --git a/googleapiclient/discovery_cache/documents/webfonts.v1.json b/googleapiclient/discovery_cache/documents/webfonts.v1.json
index de6384bb3de..7b895d2d7a9 100644
--- a/googleapiclient/discovery_cache/documents/webfonts.v1.json
+++ b/googleapiclient/discovery_cache/documents/webfonts.v1.json
@@ -109,12 +109,14 @@
 "enum": [
 "CAPABILITY_UNSPECIFIED",
 "WOFF2",
-"VF"
+"VF",
+"FAMILY_TAGS"
 ],
 "enumDescriptions": [
 "Default means static ttf fonts.",
 "Use WOFF2(Compressed)instead of ttf.",
-"Prefer variable font files instead of static fonts instantiated at standard weights."
+"Prefer variable font files instead of static fonts instantiated at standard weights.",
+"Include tags that apply to the entire family in the response."
 ],
 "location": "query",
 "repeated": true,
@@ -166,7 +168,7 @@
 }
 }
 },
-"revision": "20250121",
+"revision": "20250917",
 "rootUrl": "https://webfonts.googleapis.com/",
 "schemas": {
 "Axis": {
@@ -190,6 +192,22 @@
 },
 "type": "object"
 },
+"Tag": {
+"description": "Metadata for a tag.",
+"id": "Tag",
+"properties": {
+"name": {
+"description": "The name of the tag.",
+"type": "string"
+},
+"weight": {
+"description": "The weight of the tag.",
+"format": "float",
+"type": "number"
+}
+},
+"type": "object"
+},
 "Webfont": {
 "description": "Metadata describing a family of fonts.",
 "id": "Webfont",
@@ -242,6 +260,13 @@
 },
 "type": "array"
 },
+"tags": {
+"description": "The tags that apply to this family.",
+"items": {
+"$ref": "Tag"
+},
+"type": "array"
+},
 "variants": {
 "description": "The available variants for the font.",
 "items": {

From c329bbcfa7da48dd0eaf38bf8e8edd40521c04b0 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 30 Sep 2025 07:09:38 +0000
Subject: [PATCH 42/42] chore(docs): Add new discovery artifacts and artifacts
 with minor updates

---
 ...ctregistry_v1beta1.projects.locations.html |   2 +-
 docs/dyn/chat_v1.spaces.spaceEvents.html      |  16 +-
 ...erceprocurement_v1.providers.accounts.html |  10 +-
 ...procurement_v1.providers.entitlements.html |  56 +++----
 .../dyn/cloudtasks_v2.projects.locations.html |   2 +-
 ...oudtasks_v2.projects.locations.queues.html |  18 +--
 ...ks_v2.projects.locations.queues.tasks.html |   6 +-
 ...cloudtasks_v2beta2.projects.locations.html |   2 +-
 ...sks_v2beta2.projects.locations.queues.html |  18 +--
 ...beta2.projects.locations.queues.tasks.html |   2 +-
 ...cloudtasks_v2beta3.projects.locations.html |   2 +-
 ...sks_v2beta3.projects.locations.queues.html |  18 +--
 ...beta3.projects.locations.queues.tasks.html |   6 +-
 .../dyn/connectors_v1.projects.locations.html |   2 +-
 ...iplatform_v1alpha1.projects.locations.html |   2 +-
 ...aplex_v1.projects.locations.dataScans.html | 141 ++++++++++++++++-
 ..._v1.projects.locations.dataScans.jobs.html |  50 ++++++
 ...displayvideo_v2.advertisers.lineItems.html |  36 ++---
 ...displayvideo_v3.advertisers.lineItems.html |  20 +--
 ...displayvideo_v4.advertisers.lineItems.html |  20 +--
 ...kup_v1.projects.locations.backupPlans.html |   8 +-
 docs/dyn/gkebackup_v1.projects.locations.html |   2 +-
 docs/dyn/iam_v1.locations.workforcePools.html |  16 +-
 ...v1.locations.workforcePools.providers.html |  16 +-
 ....workforcePools.providers.scimTenants.html |  32 ++--
 ...rcePools.providers.scimTenants.tokens.html |  16 +-
 docs/dyn/memcache_v1.projects.locations.html  |   2 +-
 .../memcache_v1beta2.projects.locations.html  |   2 +-
 docs/dyn/workflows_v1.projects.locations.html |   2 +-
 .../workflows_v1beta.projects.locations.html  |   2 +-
 .../dyn/workspaceevents_v1.subscriptions.html |  20 +--
 .../documents/artifactregistry.v1beta1.json   |   4 +-
 .../discovery_cache/documents/chat.v1.json    |   8 +-
 .../cloudcommerceprocurement.v1.json          |  26 ++--
 .../documents/cloudtasks.v2.json              |  14 +-
 .../documents/cloudtasks.v2beta2.json         |  12 +-
 .../documents/cloudtasks.v2beta3.json         |  14 +-
 .../documents/connectors.v1.json              |   4 +-
 .../contactcenteraiplatform.v1alpha1.json     |   4 +-
 .../documents/content.v2.1.json               |   4 +-
 .../documents/dataplex.v1.json                | 142 +++++++++++++++++-
 .../documents/displayvideo.v2.json            |  67 ++++++---
 .../documents/displayvideo.v3.json            |  71 ++++++---
 .../documents/displayvideo.v4.json            |  71 ++++++---
 .../documents/firebaseml.v2beta.json          |  22 ++-
 .../documents/gkebackup.v1.json               |   6 +-
 .../discovery_cache/documents/iam.v1.json     |  16 +-
 .../documents/memcache.v1.json                |   4 +-
 .../documents/memcache.v1beta2.json           |   4 +-
 .../documents/workflows.v1.json               |   4 +-
 .../documents/workflows.v1beta.json           |   4 +-
 .../documents/workspaceevents.v1.json         |  10 +-
 52 files changed, 718 insertions(+), 340 deletions(-)

diff --git a/docs/dyn/artifactregistry_v1beta1.projects.locations.html b/docs/dyn/artifactregistry_v1beta1.projects.locations.html
index 4a3604a5288..52e946c894f 100644
--- a/docs/dyn/artifactregistry_v1beta1.projects.locations.html
+++ b/docs/dyn/artifactregistry_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. 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/chat_v1.spaces.spaceEvents.html b/docs/dyn/chat_v1.spaces.spaceEvents.html
index b55e2ffd035..3a63d59a254 100644
--- a/docs/dyn/chat_v1.spaces.spaceEvents.html
+++ b/docs/dyn/chat_v1.spaces.spaceEvents.html
@@ -79,10 +79,10 @@ 
Instance Methods

 
Close httplib2 connections.

 

   get(name, x__xgafv=None)

-
Returns an event from a Google Chat space. The [event payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the resource that changed. For example, if you request an event about a new message but the message was later updated, the server returns the updated `Message` resource in the event payload. Note: The `permissionSettings` field is not returned in the Space object of the Space event data for this request. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with an [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes) appropriate for reading the requested data: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.messages.reactions.readonly` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` To get an event, the authenticated user must be a member of the space. For an example, see [Get details about an event from a Google Chat space](https://developers.google.com/workspace/chat/get-space-event).

+
Returns an event from a Google Chat space. The [event payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the resource that changed. For example, if you request an event about a new message but the message was later updated, the server returns the updated `Message` resource in the event payload. Note: The `permissionSettings` field is not returned in the Space object of the Space event data for this request. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize) with an [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes) appropriate for reading the requested data: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) in [Developer Preview](https://developers.google.com/workspace/preview) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.app.spaces` - `https://www.googleapis.com/auth/chat.app.messages.readonly` - `https://www.googleapis.com/auth/chat.app.memberships` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.messages.reactions.readonly` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` To get an event, the authenticated caller must be a member of the space. For an example, see [Get details about an event from a Google Chat space](https://developers.google.com/workspace/chat/get-space-event).

 

   list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-
Lists events from a Google Chat space. For each event, the [payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the Chat resource. For example, if you list events about new space members, the server returns `Membership` resources that contain the latest membership details. If new members were removed during the requested period, the event payload contains an empty `Membership` resource. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with an [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes) appropriate for reading the requested data: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.messages.reactions.readonly` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` To list events, the authenticated user must be a member of the space. For an example, see [List events from a Google Chat space](https://developers.google.com/workspace/chat/list-space-events).

+
Lists events from a Google Chat space. For each event, the [payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the Chat resource. For example, if you list events about new space members, the server returns `Membership` resources that contain the latest membership details. If new members were removed during the requested period, the event payload contains an empty `Membership` resource. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize) with an [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes) appropriate for reading the requested data: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) in [Developer Preview](https://developers.google.com/workspace/preview) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.app.spaces` - `https://www.googleapis.com/auth/chat.app.messages.readonly` - `https://www.googleapis.com/auth/chat.app.memberships` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.messages.reactions.readonly` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` To list events, the authenticated caller must be a member of the space. For an example, see [List events from a Google Chat space](https://developers.google.com/workspace/chat/list-space-events).

 

   list_next()

 
Retrieves the next page of results.

@@ -94,7 +94,7 @@ 
Method Details

 
 

     get(name, x__xgafv=None)
-  
Returns an event from a Google Chat space. The [event payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the resource that changed. For example, if you request an event about a new message but the message was later updated, the server returns the updated `Message` resource in the event payload. Note: The `permissionSettings` field is not returned in the Space object of the Space event data for this request. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with an [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes) appropriate for reading the requested data: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.messages.reactions.readonly` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` To get an event, the authenticated user must be a member of the space. For an example, see [Get details about an event from a Google Chat space](https://developers.google.com/workspace/chat/get-space-event).
+  
Returns an event from a Google Chat space. The [event payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the resource that changed. For example, if you request an event about a new message but the message was later updated, the server returns the updated `Message` resource in the event payload. Note: The `permissionSettings` field is not returned in the Space object of the Space event data for this request. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize) with an [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes) appropriate for reading the requested data: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) in [Developer Preview](https://developers.google.com/workspace/preview) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.app.spaces` - `https://www.googleapis.com/auth/chat.app.messages.readonly` - `https://www.googleapis.com/auth/chat.app.memberships` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.messages.reactions.readonly` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` To get an event, the authenticated caller must be a member of the space. For an example, see [Get details about an event from a Google Chat space](https://developers.google.com/workspace/chat/get-space-event).
 
 Args:
   name: string, Required. The resource name of the space event. Format: `spaces/{space}/spaceEvents/{spaceEvent}` (required)
@@ -3156,7 +3156,7 @@ 
Method Details

   "messageBatchDeletedEventData": { # Event payload for multiple deleted messages. Event type: `google.workspace.chat.message.v1.batchDeleted` # Event payload for multiple deleted messages. Event type: `google.workspace.chat.message.v1.batchDeleted`
     "messages": [ # A list of deleted messages.
       { # Event payload for a deleted message. Event type: `google.workspace.chat.message.v1.deleted`
-        "message": { # A message in a Google Chat space. # The deleted message. Only the `name`, `createTime`, `deleteTime`, and `deletionMetadata` fields are populated.
+        "message": { # A message in a Google Chat space. # The deleted message. Only the `name`, `createTime`, and `deletionMetadata` fields are populated.
           "accessoryWidgets": [ # Optional. One or more interactive widgets that appear at the bottom of a message. You can add accessory widgets to messages that contain text, cards, or both text and cards. Not supported for messages that contain dialogs. For details, see [Add interactive widgets at the bottom of a message](https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets). Creating a message with accessory widgets requires [app authentication] (https://developers.google.com/workspace/chat/authenticate-authorize-chat-app).
             { # One or more interactive widgets that appear at the bottom of a message. For details, see [Add interactive widgets at the bottom of a message](https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets).
               "buttonList": { # A list of buttons layed out horizontally. For an example in Google Chat apps, see [Add a button](https://developers.google.com/workspace/chat/design-interactive-card-dialog#add_a_button). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A list of buttons.
@@ -11904,7 +11904,7 @@ 
Method Details

     },
   },
   "messageDeletedEventData": { # Event payload for a deleted message. Event type: `google.workspace.chat.message.v1.deleted` # Event payload for a deleted message. Event type: `google.workspace.chat.message.v1.deleted`
-    "message": { # A message in a Google Chat space. # The deleted message. Only the `name`, `createTime`, `deleteTime`, and `deletionMetadata` fields are populated.
+    "message": { # A message in a Google Chat space. # The deleted message. Only the `name`, `createTime`, and `deletionMetadata` fields are populated.
       "accessoryWidgets": [ # Optional. One or more interactive widgets that appear at the bottom of a message. You can add accessory widgets to messages that contain text, cards, or both text and cards. Not supported for messages that contain dialogs. For details, see [Add interactive widgets at the bottom of a message](https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets). Creating a message with accessory widgets requires [app authentication] (https://developers.google.com/workspace/chat/authenticate-authorize-chat-app).
         { # One or more interactive widgets that appear at the bottom of a message. For details, see [Add interactive widgets at the bottom of a message](https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets).
           "buttonList": { # A list of buttons layed out horizontally. For an example in Google Chat apps, see [Add a button](https://developers.google.com/workspace/chat/design-interactive-card-dialog#add_a_button). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A list of buttons.
@@ -17983,7 +17983,7 @@ 
Method Details

 
 

     list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
-  
Lists events from a Google Chat space. For each event, the [payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the Chat resource. For example, if you list events about new space members, the server returns `Membership` resources that contain the latest membership details. If new members were removed during the requested period, the event payload contains an empty `Membership` resource. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with an [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes) appropriate for reading the requested data: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.messages.reactions.readonly` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` To list events, the authenticated user must be a member of the space. For an example, see [List events from a Google Chat space](https://developers.google.com/workspace/chat/list-space-events).
+  
Lists events from a Google Chat space. For each event, the [payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the Chat resource. For example, if you list events about new space members, the server returns `Membership` resources that contain the latest membership details. If new members were removed during the requested period, the event payload contains an empty `Membership` resource. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize) with an [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes) appropriate for reading the requested data: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) in [Developer Preview](https://developers.google.com/workspace/preview) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.app.spaces` - `https://www.googleapis.com/auth/chat.app.messages.readonly` - `https://www.googleapis.com/auth/chat.app.memberships` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.messages.reactions.readonly` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` To list events, the authenticated caller must be a member of the space. For an example, see [List events from a Google Chat space](https://developers.google.com/workspace/chat/list-space-events).
 
 Args:
   parent: string, Required. Resource name of the [Google Chat space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) where the events occurred. Format: `spaces/{space}`. (required)
@@ -21051,7 +21051,7 @@ 
Method Details

       "messageBatchDeletedEventData": { # Event payload for multiple deleted messages. Event type: `google.workspace.chat.message.v1.batchDeleted` # Event payload for multiple deleted messages. Event type: `google.workspace.chat.message.v1.batchDeleted`
         "messages": [ # A list of deleted messages.
           { # Event payload for a deleted message. Event type: `google.workspace.chat.message.v1.deleted`
-            "message": { # A message in a Google Chat space. # The deleted message. Only the `name`, `createTime`, `deleteTime`, and `deletionMetadata` fields are populated.
+            "message": { # A message in a Google Chat space. # The deleted message. Only the `name`, `createTime`, and `deletionMetadata` fields are populated.
               "accessoryWidgets": [ # Optional. One or more interactive widgets that appear at the bottom of a message. You can add accessory widgets to messages that contain text, cards, or both text and cards. Not supported for messages that contain dialogs. For details, see [Add interactive widgets at the bottom of a message](https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets). Creating a message with accessory widgets requires [app authentication] (https://developers.google.com/workspace/chat/authenticate-authorize-chat-app).
                 { # One or more interactive widgets that appear at the bottom of a message. For details, see [Add interactive widgets at the bottom of a message](https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets).
                   "buttonList": { # A list of buttons layed out horizontally. For an example in Google Chat apps, see [Add a button](https://developers.google.com/workspace/chat/design-interactive-card-dialog#add_a_button). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A list of buttons.
@@ -29799,7 +29799,7 @@ 
Method Details

         },
       },
       "messageDeletedEventData": { # Event payload for a deleted message. Event type: `google.workspace.chat.message.v1.deleted` # Event payload for a deleted message. Event type: `google.workspace.chat.message.v1.deleted`
-        "message": { # A message in a Google Chat space. # The deleted message. Only the `name`, `createTime`, `deleteTime`, and `deletionMetadata` fields are populated.
+        "message": { # A message in a Google Chat space. # The deleted message. Only the `name`, `createTime`, and `deletionMetadata` fields are populated.
           "accessoryWidgets": [ # Optional. One or more interactive widgets that appear at the bottom of a message. You can add accessory widgets to messages that contain text, cards, or both text and cards. Not supported for messages that contain dialogs. For details, see [Add interactive widgets at the bottom of a message](https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets). Creating a message with accessory widgets requires [app authentication] (https://developers.google.com/workspace/chat/authenticate-authorize-chat-app).
             { # One or more interactive widgets that appear at the bottom of a message. For details, see [Add interactive widgets at the bottom of a message](https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets).
               "buttonList": { # A list of buttons layed out horizontally. For an example in Google Chat apps, see [Add a button](https://developers.google.com/workspace/chat/design-interactive-card-dialog#add_a_button). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A list of buttons.
diff --git a/docs/dyn/cloudcommerceprocurement_v1.providers.accounts.html b/docs/dyn/cloudcommerceprocurement_v1.providers.accounts.html
index 4cc645b6bbd..18396c5cc6f 100644
--- a/docs/dyn/cloudcommerceprocurement_v1.providers.accounts.html
+++ b/docs/dyn/cloudcommerceprocurement_v1.providers.accounts.html
@@ -138,9 +138,9 @@ 
Method Details

   name: string, Required. The name of the account to retrieve. (required)
   view: string, Optional. What information to include in the response.
     Allowed values
-      ACCOUNT_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view for ListAccounts. For GetAccount it will default to the FULL view.
-      ACCOUNT_VIEW_BASIC - Include base account information. This is the default view.
-      ACCOUNT_VIEW_FULL - Include everything.
+      ACCOUNT_VIEW_UNSPECIFIED - The default / unset value. For `GetAccount`, it defaults to the FULL view. For `ListAccounts`, it only supports BASIC view.
+      ACCOUNT_VIEW_BASIC - Include base account information. This is the default view. All fields from Account are included except for the reseller_parent_billing_account field.
+      ACCOUNT_VIEW_FULL - Includes all available account information, inclusive of the accounts reseller_parent_billing_account, if it's a resold account.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -164,7 +164,7 @@ 
Method Details

   },
   "name": "A String", # Output only. The resource name of the account. Account names have the form `accounts/{account_id}`.
   "provider": "A String", # Output only. The identifier of the service provider that this account was created against. Each service provider is assigned a unique provider value when they onboard with Cloud Commerce platform.
-  "resellerParentBillingAccount": "A String", # The reseller parent billing account of the account's corresponding billing account, applicable only when the corresponding billing account is a subaccount of a reseller. Included in responses only for view ACCOUNT_VIEW_FULL. Format: billingAccounts/{billing_account_id}
+  "resellerParentBillingAccount": "A String", # Output only. The reseller parent billing account of the account's corresponding billing account, applicable only when the corresponding billing account is a subaccount of a reseller. Included in responses only for view: ACCOUNT_VIEW_FULL. Format: billingAccounts/{billing_account_id}
   "state": "A String", # Output only. The state of the account. This is used to decide whether the customer is in good standing with the provider and is able to make purchases. An account might not be able to make a purchase if the billing account is suspended, for example.
   "updateTime": "A String", # Output only. The last update timestamp.
 }

@@ -203,7 +203,7 @@ 
Method Details

       },
       "name": "A String", # Output only. The resource name of the account. Account names have the form `accounts/{account_id}`.
       "provider": "A String", # Output only. The identifier of the service provider that this account was created against. Each service provider is assigned a unique provider value when they onboard with Cloud Commerce platform.
-      "resellerParentBillingAccount": "A String", # The reseller parent billing account of the account's corresponding billing account, applicable only when the corresponding billing account is a subaccount of a reseller. Included in responses only for view ACCOUNT_VIEW_FULL. Format: billingAccounts/{billing_account_id}
+      "resellerParentBillingAccount": "A String", # Output only. The reseller parent billing account of the account's corresponding billing account, applicable only when the corresponding billing account is a subaccount of a reseller. Included in responses only for view: ACCOUNT_VIEW_FULL. Format: billingAccounts/{billing_account_id}
       "state": "A String", # Output only. The state of the account. This is used to decide whether the customer is in good standing with the provider and is able to make purchases. An account might not be able to make a purchase if the billing account is suspended, for example.
       "updateTime": "A String", # Output only. The last update timestamp.
     },
diff --git a/docs/dyn/cloudcommerceprocurement_v1.providers.entitlements.html b/docs/dyn/cloudcommerceprocurement_v1.providers.entitlements.html
index 40e746af565..3d4693082b1 100644
--- a/docs/dyn/cloudcommerceprocurement_v1.providers.entitlements.html
+++ b/docs/dyn/cloudcommerceprocurement_v1.providers.entitlements.html
@@ -194,14 +194,14 @@ 
Method Details

   },
   "messageToUser": "A String", # Provider-supplied message that is displayed to the end user. Currently this is used to communicate progress and ETA for provisioning. This field can be updated only when a user is waiting for an action from the provider, i.e. entitlement state is EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED or EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL. This field is cleared automatically when the entitlement state changes.
   "name": "A String", # Output only. The resource name of the entitlement. Entitlement names have the form `providers/{provider_id}/entitlements/{entitlement_id}`.
-  "newOfferEndTime": "A String", # Output only. The end time of the new offer. If the offer was has a term duration instead of a specified end date, this field is empty. This field is populated even if the entitlement isn't active yet. If there's no upcoming offer, the field is empty. * If the entitlement is in ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEMENT_ACTIVE, or ENTITLEMENT_PENDING_CANCELLATION state, then this field will be empty. * If the entitlement is in ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE state, then this field will be populated with the expected end time of the upcoming offer (in the future) if the upcoming offer has a specified end date. Otherwise, this field will be empty. * If the entitlement is in ENTITLEMENT_CANCELLED state, then this field will be empty.
-  "newOfferStartTime": "A String", # Output only. The timestamp when the new offer becomes effective. This field is populated even if the entitlement isn't active yet. If there's no upcoming offer, the field is empty. * If the entitlement is in ENTITLEMENT_ACTIVATION_REQUESTED state, this field will not be populated when the entitlement is not yet approved. But after the entitlement is approved, then this field will be populated with effective time of the upcoming offer. * If the entitlement is in ENTITLEMENT_ACTIVE or ENTITLEMENT_PENDING_CANCELLATION state, this field will not be populated. * If the entitlement is in ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state, this field will not be populated since the entitlement change is waiting on approval. * If the entitlement is in ENTITLEMENT_PENDING_PLAN_CHANGE state, this field will be populated with the expected effective time of the upcoming offer (in the future). * If the entitlement is in ENTITLEMENT_CANCELLED state, then this field will be empty.
-  "newPendingOffer": "A String", # Output only. The name of the offer the entitlement is switching to upon a pending plan change. Only exists if the pending plan change is moving to an offer. This field isn't populated for entitlements which aren't active yet. Format: 'projects/{project}/services/{service}/privateOffers/{offer}' OR 'projects/{project}/services/{service}/standardOffers/{offer}', depending on whether the offer is private or public. The {service} in the name is the listing service of the offer. It could be either the product service that the offer is referencing, or a generic private offer parent service. We recommend that you don't build your integration to rely on the meaning of this {service} part. * If the entitlement is in ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEMENT_ACTIVE or ENTITLEMENT_PENDING_CANCELLATION state, then this field will be empty. * If the entitlement is in ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE state, then this field will be populated with the upcoming offer. * If the entitlement is in ENTITLEMENT_CANCELLED state, then this will be empty.
-  "newPendingOfferDuration": "A String", # Output only. The duration of the new offer, in ISO 8601 duration format. This field isn't populated for entitlements which aren't active yet, only for pending offer changes. If the offer was has a specified end date instead of a duration, this field is empty. * If the entitlement is in ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEENTITLEMENT_ACTIVE, or ENTITLEMENT_PENDING_CANCELLATION state, then this field is empty. * If the entitlement is in ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE state, then this field will be populated with the duration of the upcoming offer, if the upcoming offer is does not have a specified end date. Otherwise, this field will be empty. * If the entitlement is in ENTITLEMENT_CANCELLED state, then this field will be empty.
+  "newOfferEndTime": "A String", # Output only. The end time of the new offer, determined from the offer's specified end date. If the offer des not have a specified end date then this field is not set. This field is populated even if the entitlement isn't active yet. If there's no upcoming offer, the field is empty. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEMENT_ACTIVE, or ENTITLEMENT_PENDING_CANCELLATION, then this field is empty. * If the entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE, and the upcoming offer has a specified end date, then this field is populated with the expected end time of the upcoming offer, in the future. Otherwise, this field is empty. * If the entitlement is in the state ENTITLEMENT_CANCELLED, then this field is empty.
+  "newOfferStartTime": "A String", # Output only. The timestamp when the new offer becomes effective. This field is populated even if the entitlement isn't active yet. If there's no upcoming offer, the field is empty. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, this field isn't populated when the entitlement isn't yet approved. After the entitlement is approved, this field is populated with the effective time of the upcoming offer. * If the entitlement is in the state ENTITLEMENT_ACTIVE or ENTITLEMENT_PENDING_CANCELLATION, this field isn't populated. * If the entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL, this field isn't populated, because the entitlement change is waiting on approval. * If the entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE, this field is populated with the expected effective time of the upcoming offer, which is in the future. * If the entitlement is in the state ENTITLEMENT_CANCELLED, then this field is empty.
+  "newPendingOffer": "A String", # Output only. Upon a pending plan change, the name of the offer that the entitlement is switching to. Only exists if the pending plan change is moving to an offer. This field isn't populated for entitlements which aren't active yet. Format: 'projects/{project}/services/{service}/privateOffers/{offer}' OR 'projects/{project}/services/{service}/standardOffers/{offer}', depending on whether the offer is private or public. The {service} in the name is the listing service of the offer. It could be either the product service that the offer is referencing, or a generic private offer parent service. We recommend that you don't build your integration to rely on the meaning of this {service} part. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEMENT_ACTIVE or ENTITLEMENT_PENDING_CANCELLATION, then this field is empty. * If the entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE, then this field is populated with the upcoming offer. * If the entitlement is in the state ENTITLEMENT_CANCELLED, then this is empty.
+  "newPendingOfferDuration": "A String", # Output only. The duration of the new offer, in ISO 8601 duration format. This field is populated for pending offer changes. It isn't populated for entitlements which aren't active yet. If the offer has a specified end date instead of a duration, this field is empty. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEMENT_ACTIVE, or ENTITLEMENT_PENDING_CANCELLATION, this field is empty. * If the entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE, and the upcoming offer doesn't have a specified end date, then this field is populated with the duration of the upcoming offer. Otherwise, this field is empty. * If the entitlement is in the state ENTITLEMENT_CANCELLED, then this field is empty.
   "newPendingPlan": "A String", # Output only. The identifier of the pending new plan. Required if the product has plans and the entitlement has a pending plan change.
-  "offer": "A String", # Output only. The name of the offer that was procured. Field is empty if order was not made using an offer. Format: 'projects/{project}/services/{service}/privateOffers/{offer}' OR 'projects/{project}/services/{service}/standardOffers/{offer}', depending on whether the offer is private or public. The {service} in the name is the listing service of the offer. It could be either the product service that the offer is referencing, or a generic private offer parent service. We recommend that you don't build your integration to rely on the meaning of this {service} part. * If the entitlement is in ENTITLEMENT_ACTIVATION_REQUESTED state, this field will be populated with the upcoming offer. * If the entitlement is in ENTITLEMENT_ACTIVE, ENTITLEMENT_PENDING_CANCELLATION, ENTITLEMENT_PENDING_PLAN_CHANGE, or ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state, this field will be populated with the current offer. * If the entitlement is in ENTITLEMENT_CANCELLED state, then this field will be populated with the latest offer the order was associated with.
-  "offerDuration": "A String", # Output only. The offer duration of the current offer in ISO 8601 duration format. Field is empty if entitlement was not made using an offer. If the offer has a specified end date instead of a duration, this field is empty. * If the entitlement is in ENTITLEMENT_ACTIVATION_REQUESTED state, then this field will be populated with the duration of the upcoming offer, if the upcoming offer does not have a specified end date. Otherwise, this field will be empty. * If the entitlement is in ENTITLEMENT_ACTIVE, ENTITLEMENT_PENDING_CANCELLATION, ENTITLEMENT_PENDING_PLAN_CHANGE, or ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state, then this field will be populated with the duration of the current offer if the current offer is does not have a specific end date. Otherwise, this field will be empty. * If the entitlement is in ENTITLEMENT_CANCELLED state, then this field will be populated with the duration of the latest offer the order was associated with if that offer does not have a specific end date. Otherwise, this field will be empty.
-  "offerEndTime": "A String", # Output only. End time for the Offer associated with this entitlement. Note that this field value can change over time. This occurs naturally even if the offer is not changed, due to auto renewal. * If the entitlement is in ENTITLEMENT_ACTIVATION_REQUESTED state, then: * If the entitlement is not yet approved, then this field will be populated with the expected end time of the upcoming offer (in the future) if the upcoming offer has a specified end date. Otherwise this field will be empty. * If the entitlement is approved, then this field will always be populated with the expected end time of the upcoming offer (in the future). This means both this field, and the offer_duration field, can co-exist. * If the entitlement is in ENTITLEMENT_ACTIVE or ENTITLEMENT_PENDING_CANCELLATION state, then this field will be populated with the actual expected end time of the current offer (in the futre). Meaning, this field will be set, regardless of whether the offer has a specific end date or a duration. This means both this field, and the offer_duration field, can co-exist. * If the entitlement is in ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE state: * If the current offer has already ended and became pure PAYG, then this field reflects the ACTUAL end time of the current offer (in the past). * Otherwise, then this is the EXPECTED end date of the current offer (in the future). * If the entitlement is in ENTITLEMENT_CANCELLED state, then this field will be populated with the ACTUAL end time of the latest offer the order was associated with (in the past). If the entitlement was cancelled before any offer started, then this field will be empty.
+  "offer": "A String", # Output only. The name of the offer that was procured. Field is empty if order wasn't made using an offer. Format: 'projects/{project}/services/{service}/privateOffers/{offer}' OR 'projects/{project}/services/{service}/standardOffers/{offer}', depending on whether the offer is private or public. The {service} in the name is the listing service of the offer. It could be either the product service that the offer is referencing, or a generic private offer parent service. We recommend that you don't build your integration to rely on the meaning of this {service} part. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, this field is populated with the upcoming offer. * If the entitlement is in the state ENTITLEMENT_ACTIVE, ENTITLEMENT_PENDING_CANCELLATION, ENTITLEMENT_PENDING_PLAN_CHANGE, or ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL, this field is populated with the current offer. * If the entitlement is in the state ENTITLEMENT_CANCELLED, then this field is populated with the latest offer that the order was associated with.
+  "offerDuration": "A String", # Output only. The offer duration of the current offer, in ISO 8601 duration format. This is empty if the entitlement wasn't made using an offer, or if the offer has a specified end date instead of a duration. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, and the upcoming offer doesn't have a specified end date, then this field is populated with the duration of the upcoming offer. Otherwise, this field is empty. * If the entitlement is in the state ENTITLEMENT_ACTIVE, ENTITLEMENT_PENDING_CANCELLATION, ENTITLEMENT_PENDING_PLAN_CHANGE, or ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL, and the current offer doesn't have a specified end date, then this field contains the duration of the current offer. Otherwise, this field is empty. * If the entitlement is in the state ENTITLEMENT_CANCELLED, and the offer doesn't have a specified end date, then this field is populated with the duration of the latest offer that the order was associated with. Otherwise, this field is empty.
+  "offerEndTime": "A String", # Output only. End time for the current term of the Offer associated with this entitlement. The value of this field can change naturally over time due to auto-renewal, even if the offer isn't changed. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, then: * If the entitlement isn't approved yet approved, and the offer has a specified end date, then this field is populated with the expected end time of the upcoming offer, in the future. Otherwise, this field is empty. * If the entitlement is approved, then this field is populated with the expected end time of the upcoming offer, in the future. This means that this field and the field offer_duration can both exist. * If the entitlement is in the state ENTITLEMENT_ACTIVE or ENTITLEMENT_PENDING_CANCELLATION, then this field is populated with the expected end time of the current offer, in the future. This field's value is set regardless of whether the offer has a specific end date or a duration. This means that this field and the field offer_duration can both exist. * If the entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE: * If the entitlement's pricing model is usage based and the associated offer is a private offer whose term has ended, then this field reflects the ACTUAL end time of the entitlement's associated offer (in the past), even though the entitlement associated with this private offer does not terminate at the end of that private offer's term. * Otherwise, this is the expected end date of the current offer, in the future. * If the entitlement is in the state ENTITLEMENT_CANCELLED, then this field is populated with the end time, in the past, of the latest offer that the order was associated with. If the entitlement was cancelled before any offer started, then this field is empty.
   "orderId": "A String", # Output only. The order ID of this entitlement, without any `orders/` resource name prefix.
   "plan": "A String", # Output only. The identifier of the plan that was procured. Required if the product has plans.
   "product": "A String", # Output only. The identifier of the entity that was purchased. This may actually represent a product, quote, or offer. We strongly recommend that you use the following more explicit fields: productExternalName, quoteExternalName, or offer.
@@ -251,14 +251,14 @@ 
Method Details

       },
       "messageToUser": "A String", # Provider-supplied message that is displayed to the end user. Currently this is used to communicate progress and ETA for provisioning. This field can be updated only when a user is waiting for an action from the provider, i.e. entitlement state is EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED or EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL. This field is cleared automatically when the entitlement state changes.
       "name": "A String", # Output only. The resource name of the entitlement. Entitlement names have the form `providers/{provider_id}/entitlements/{entitlement_id}`.
-      "newOfferEndTime": "A String", # Output only. The end time of the new offer. If the offer was has a term duration instead of a specified end date, this field is empty. This field is populated even if the entitlement isn't active yet. If there's no upcoming offer, the field is empty. * If the entitlement is in ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEMENT_ACTIVE, or ENTITLEMENT_PENDING_CANCELLATION state, then this field will be empty. * If the entitlement is in ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE state, then this field will be populated with the expected end time of the upcoming offer (in the future) if the upcoming offer has a specified end date. Otherwise, this field will be empty. * If the entitlement is in ENTITLEMENT_CANCELLED state, then this field will be empty.
-      "newOfferStartTime": "A String", # Output only. The timestamp when the new offer becomes effective. This field is populated even if the entitlement isn't active yet. If there's no upcoming offer, the field is empty. * If the entitlement is in ENTITLEMENT_ACTIVATION_REQUESTED state, this field will not be populated when the entitlement is not yet approved. But after the entitlement is approved, then this field will be populated with effective time of the upcoming offer. * If the entitlement is in ENTITLEMENT_ACTIVE or ENTITLEMENT_PENDING_CANCELLATION state, this field will not be populated. * If the entitlement is in ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state, this field will not be populated since the entitlement change is waiting on approval. * If the entitlement is in ENTITLEMENT_PENDING_PLAN_CHANGE state, this field will be populated with the expected effective time of the upcoming offer (in the future). * If the entitlement is in ENTITLEMENT_CANCELLED state, then this field will be empty.
-      "newPendingOffer": "A String", # Output only. The name of the offer the entitlement is switching to upon a pending plan change. Only exists if the pending plan change is moving to an offer. This field isn't populated for entitlements which aren't active yet. Format: 'projects/{project}/services/{service}/privateOffers/{offer}' OR 'projects/{project}/services/{service}/standardOffers/{offer}', depending on whether the offer is private or public. The {service} in the name is the listing service of the offer. It could be either the product service that the offer is referencing, or a generic private offer parent service. We recommend that you don't build your integration to rely on the meaning of this {service} part. * If the entitlement is in ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEMENT_ACTIVE or ENTITLEMENT_PENDING_CANCELLATION state, then this field will be empty. * If the entitlement is in ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE state, then this field will be populated with the upcoming offer. * If the entitlement is in ENTITLEMENT_CANCELLED state, then this will be empty.
-      "newPendingOfferDuration": "A String", # Output only. The duration of the new offer, in ISO 8601 duration format. This field isn't populated for entitlements which aren't active yet, only for pending offer changes. If the offer was has a specified end date instead of a duration, this field is empty. * If the entitlement is in ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEENTITLEMENT_ACTIVE, or ENTITLEMENT_PENDING_CANCELLATION state, then this field is empty. * If the entitlement is in ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE state, then this field will be populated with the duration of the upcoming offer, if the upcoming offer is does not have a specified end date. Otherwise, this field will be empty. * If the entitlement is in ENTITLEMENT_CANCELLED state, then this field will be empty.
+      "newOfferEndTime": "A String", # Output only. The end time of the new offer, determined from the offer's specified end date. If the offer des not have a specified end date then this field is not set. This field is populated even if the entitlement isn't active yet. If there's no upcoming offer, the field is empty. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEMENT_ACTIVE, or ENTITLEMENT_PENDING_CANCELLATION, then this field is empty. * If the entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE, and the upcoming offer has a specified end date, then this field is populated with the expected end time of the upcoming offer, in the future. Otherwise, this field is empty. * If the entitlement is in the state ENTITLEMENT_CANCELLED, then this field is empty.
+      "newOfferStartTime": "A String", # Output only. The timestamp when the new offer becomes effective. This field is populated even if the entitlement isn't active yet. If there's no upcoming offer, the field is empty. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, this field isn't populated when the entitlement isn't yet approved. After the entitlement is approved, this field is populated with the effective time of the upcoming offer. * If the entitlement is in the state ENTITLEMENT_ACTIVE or ENTITLEMENT_PENDING_CANCELLATION, this field isn't populated. * If the entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL, this field isn't populated, because the entitlement change is waiting on approval. * If the entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE, this field is populated with the expected effective time of the upcoming offer, which is in the future. * If the entitlement is in the state ENTITLEMENT_CANCELLED, then this field is empty.
+      "newPendingOffer": "A String", # Output only. Upon a pending plan change, the name of the offer that the entitlement is switching to. Only exists if the pending plan change is moving to an offer. This field isn't populated for entitlements which aren't active yet. Format: 'projects/{project}/services/{service}/privateOffers/{offer}' OR 'projects/{project}/services/{service}/standardOffers/{offer}', depending on whether the offer is private or public. The {service} in the name is the listing service of the offer. It could be either the product service that the offer is referencing, or a generic private offer parent service. We recommend that you don't build your integration to rely on the meaning of this {service} part. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEMENT_ACTIVE or ENTITLEMENT_PENDING_CANCELLATION, then this field is empty. * If the entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE, then this field is populated with the upcoming offer. * If the entitlement is in the state ENTITLEMENT_CANCELLED, then this is empty.
+      "newPendingOfferDuration": "A String", # Output only. The duration of the new offer, in ISO 8601 duration format. This field is populated for pending offer changes. It isn't populated for entitlements which aren't active yet. If the offer has a specified end date instead of a duration, this field is empty. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEMENT_ACTIVE, or ENTITLEMENT_PENDING_CANCELLATION, this field is empty. * If the entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE, and the upcoming offer doesn't have a specified end date, then this field is populated with the duration of the upcoming offer. Otherwise, this field is empty. * If the entitlement is in the state ENTITLEMENT_CANCELLED, then this field is empty.
       "newPendingPlan": "A String", # Output only. The identifier of the pending new plan. Required if the product has plans and the entitlement has a pending plan change.
-      "offer": "A String", # Output only. The name of the offer that was procured. Field is empty if order was not made using an offer. Format: 'projects/{project}/services/{service}/privateOffers/{offer}' OR 'projects/{project}/services/{service}/standardOffers/{offer}', depending on whether the offer is private or public. The {service} in the name is the listing service of the offer. It could be either the product service that the offer is referencing, or a generic private offer parent service. We recommend that you don't build your integration to rely on the meaning of this {service} part. * If the entitlement is in ENTITLEMENT_ACTIVATION_REQUESTED state, this field will be populated with the upcoming offer. * If the entitlement is in ENTITLEMENT_ACTIVE, ENTITLEMENT_PENDING_CANCELLATION, ENTITLEMENT_PENDING_PLAN_CHANGE, or ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state, this field will be populated with the current offer. * If the entitlement is in ENTITLEMENT_CANCELLED state, then this field will be populated with the latest offer the order was associated with.
-      "offerDuration": "A String", # Output only. The offer duration of the current offer in ISO 8601 duration format. Field is empty if entitlement was not made using an offer. If the offer has a specified end date instead of a duration, this field is empty. * If the entitlement is in ENTITLEMENT_ACTIVATION_REQUESTED state, then this field will be populated with the duration of the upcoming offer, if the upcoming offer does not have a specified end date. Otherwise, this field will be empty. * If the entitlement is in ENTITLEMENT_ACTIVE, ENTITLEMENT_PENDING_CANCELLATION, ENTITLEMENT_PENDING_PLAN_CHANGE, or ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state, then this field will be populated with the duration of the current offer if the current offer is does not have a specific end date. Otherwise, this field will be empty. * If the entitlement is in ENTITLEMENT_CANCELLED state, then this field will be populated with the duration of the latest offer the order was associated with if that offer does not have a specific end date. Otherwise, this field will be empty.
-      "offerEndTime": "A String", # Output only. End time for the Offer associated with this entitlement. Note that this field value can change over time. This occurs naturally even if the offer is not changed, due to auto renewal. * If the entitlement is in ENTITLEMENT_ACTIVATION_REQUESTED state, then: * If the entitlement is not yet approved, then this field will be populated with the expected end time of the upcoming offer (in the future) if the upcoming offer has a specified end date. Otherwise this field will be empty. * If the entitlement is approved, then this field will always be populated with the expected end time of the upcoming offer (in the future). This means both this field, and the offer_duration field, can co-exist. * If the entitlement is in ENTITLEMENT_ACTIVE or ENTITLEMENT_PENDING_CANCELLATION state, then this field will be populated with the actual expected end time of the current offer (in the futre). Meaning, this field will be set, regardless of whether the offer has a specific end date or a duration. This means both this field, and the offer_duration field, can co-exist. * If the entitlement is in ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE state: * If the current offer has already ended and became pure PAYG, then this field reflects the ACTUAL end time of the current offer (in the past). * Otherwise, then this is the EXPECTED end date of the current offer (in the future). * If the entitlement is in ENTITLEMENT_CANCELLED state, then this field will be populated with the ACTUAL end time of the latest offer the order was associated with (in the past). If the entitlement was cancelled before any offer started, then this field will be empty.
+      "offer": "A String", # Output only. The name of the offer that was procured. Field is empty if order wasn't made using an offer. Format: 'projects/{project}/services/{service}/privateOffers/{offer}' OR 'projects/{project}/services/{service}/standardOffers/{offer}', depending on whether the offer is private or public. The {service} in the name is the listing service of the offer. It could be either the product service that the offer is referencing, or a generic private offer parent service. We recommend that you don't build your integration to rely on the meaning of this {service} part. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, this field is populated with the upcoming offer. * If the entitlement is in the state ENTITLEMENT_ACTIVE, ENTITLEMENT_PENDING_CANCELLATION, ENTITLEMENT_PENDING_PLAN_CHANGE, or ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL, this field is populated with the current offer. * If the entitlement is in the state ENTITLEMENT_CANCELLED, then this field is populated with the latest offer that the order was associated with.
+      "offerDuration": "A String", # Output only. The offer duration of the current offer, in ISO 8601 duration format. This is empty if the entitlement wasn't made using an offer, or if the offer has a specified end date instead of a duration. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, and the upcoming offer doesn't have a specified end date, then this field is populated with the duration of the upcoming offer. Otherwise, this field is empty. * If the entitlement is in the state ENTITLEMENT_ACTIVE, ENTITLEMENT_PENDING_CANCELLATION, ENTITLEMENT_PENDING_PLAN_CHANGE, or ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL, and the current offer doesn't have a specified end date, then this field contains the duration of the current offer. Otherwise, this field is empty. * If the entitlement is in the state ENTITLEMENT_CANCELLED, and the offer doesn't have a specified end date, then this field is populated with the duration of the latest offer that the order was associated with. Otherwise, this field is empty.
+      "offerEndTime": "A String", # Output only. End time for the current term of the Offer associated with this entitlement. The value of this field can change naturally over time due to auto-renewal, even if the offer isn't changed. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, then: * If the entitlement isn't approved yet approved, and the offer has a specified end date, then this field is populated with the expected end time of the upcoming offer, in the future. Otherwise, this field is empty. * If the entitlement is approved, then this field is populated with the expected end time of the upcoming offer, in the future. This means that this field and the field offer_duration can both exist. * If the entitlement is in the state ENTITLEMENT_ACTIVE or ENTITLEMENT_PENDING_CANCELLATION, then this field is populated with the expected end time of the current offer, in the future. This field's value is set regardless of whether the offer has a specific end date or a duration. This means that this field and the field offer_duration can both exist. * If the entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE: * If the entitlement's pricing model is usage based and the associated offer is a private offer whose term has ended, then this field reflects the ACTUAL end time of the entitlement's associated offer (in the past), even though the entitlement associated with this private offer does not terminate at the end of that private offer's term. * Otherwise, this is the expected end date of the current offer, in the future. * If the entitlement is in the state ENTITLEMENT_CANCELLED, then this field is populated with the end time, in the past, of the latest offer that the order was associated with. If the entitlement was cancelled before any offer started, then this field is empty.
       "orderId": "A String", # Output only. The order ID of this entitlement, without any `orders/` resource name prefix.
       "plan": "A String", # Output only. The identifier of the plan that was procured. Required if the product has plans.
       "product": "A String", # Output only. The identifier of the entity that was purchased. This may actually represent a product, quote, or offer. We strongly recommend that you use the following more explicit fields: productExternalName, quoteExternalName, or offer.
@@ -315,14 +315,14 @@ 
Method Details

   },
   "messageToUser": "A String", # Provider-supplied message that is displayed to the end user. Currently this is used to communicate progress and ETA for provisioning. This field can be updated only when a user is waiting for an action from the provider, i.e. entitlement state is EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED or EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL. This field is cleared automatically when the entitlement state changes.
   "name": "A String", # Output only. The resource name of the entitlement. Entitlement names have the form `providers/{provider_id}/entitlements/{entitlement_id}`.
-  "newOfferEndTime": "A String", # Output only. The end time of the new offer. If the offer was has a term duration instead of a specified end date, this field is empty. This field is populated even if the entitlement isn't active yet. If there's no upcoming offer, the field is empty. * If the entitlement is in ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEMENT_ACTIVE, or ENTITLEMENT_PENDING_CANCELLATION state, then this field will be empty. * If the entitlement is in ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE state, then this field will be populated with the expected end time of the upcoming offer (in the future) if the upcoming offer has a specified end date. Otherwise, this field will be empty. * If the entitlement is in ENTITLEMENT_CANCELLED state, then this field will be empty.
-  "newOfferStartTime": "A String", # Output only. The timestamp when the new offer becomes effective. This field is populated even if the entitlement isn't active yet. If there's no upcoming offer, the field is empty. * If the entitlement is in ENTITLEMENT_ACTIVATION_REQUESTED state, this field will not be populated when the entitlement is not yet approved. But after the entitlement is approved, then this field will be populated with effective time of the upcoming offer. * If the entitlement is in ENTITLEMENT_ACTIVE or ENTITLEMENT_PENDING_CANCELLATION state, this field will not be populated. * If the entitlement is in ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state, this field will not be populated since the entitlement change is waiting on approval. * If the entitlement is in ENTITLEMENT_PENDING_PLAN_CHANGE state, this field will be populated with the expected effective time of the upcoming offer (in the future). * If the entitlement is in ENTITLEMENT_CANCELLED state, then this field will be empty.
-  "newPendingOffer": "A String", # Output only. The name of the offer the entitlement is switching to upon a pending plan change. Only exists if the pending plan change is moving to an offer. This field isn't populated for entitlements which aren't active yet. Format: 'projects/{project}/services/{service}/privateOffers/{offer}' OR 'projects/{project}/services/{service}/standardOffers/{offer}', depending on whether the offer is private or public. The {service} in the name is the listing service of the offer. It could be either the product service that the offer is referencing, or a generic private offer parent service. We recommend that you don't build your integration to rely on the meaning of this {service} part. * If the entitlement is in ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEMENT_ACTIVE or ENTITLEMENT_PENDING_CANCELLATION state, then this field will be empty. * If the entitlement is in ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE state, then this field will be populated with the upcoming offer. * If the entitlement is in ENTITLEMENT_CANCELLED state, then this will be empty.
-  "newPendingOfferDuration": "A String", # Output only. The duration of the new offer, in ISO 8601 duration format. This field isn't populated for entitlements which aren't active yet, only for pending offer changes. If the offer was has a specified end date instead of a duration, this field is empty. * If the entitlement is in ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEENTITLEMENT_ACTIVE, or ENTITLEMENT_PENDING_CANCELLATION state, then this field is empty. * If the entitlement is in ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE state, then this field will be populated with the duration of the upcoming offer, if the upcoming offer is does not have a specified end date. Otherwise, this field will be empty. * If the entitlement is in ENTITLEMENT_CANCELLED state, then this field will be empty.
+  "newOfferEndTime": "A String", # Output only. The end time of the new offer, determined from the offer's specified end date. If the offer des not have a specified end date then this field is not set. This field is populated even if the entitlement isn't active yet. If there's no upcoming offer, the field is empty. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEMENT_ACTIVE, or ENTITLEMENT_PENDING_CANCELLATION, then this field is empty. * If the entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE, and the upcoming offer has a specified end date, then this field is populated with the expected end time of the upcoming offer, in the future. Otherwise, this field is empty. * If the entitlement is in the state ENTITLEMENT_CANCELLED, then this field is empty.
+  "newOfferStartTime": "A String", # Output only. The timestamp when the new offer becomes effective. This field is populated even if the entitlement isn't active yet. If there's no upcoming offer, the field is empty. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, this field isn't populated when the entitlement isn't yet approved. After the entitlement is approved, this field is populated with the effective time of the upcoming offer. * If the entitlement is in the state ENTITLEMENT_ACTIVE or ENTITLEMENT_PENDING_CANCELLATION, this field isn't populated. * If the entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL, this field isn't populated, because the entitlement change is waiting on approval. * If the entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE, this field is populated with the expected effective time of the upcoming offer, which is in the future. * If the entitlement is in the state ENTITLEMENT_CANCELLED, then this field is empty.
+  "newPendingOffer": "A String", # Output only. Upon a pending plan change, the name of the offer that the entitlement is switching to. Only exists if the pending plan change is moving to an offer. This field isn't populated for entitlements which aren't active yet. Format: 'projects/{project}/services/{service}/privateOffers/{offer}' OR 'projects/{project}/services/{service}/standardOffers/{offer}', depending on whether the offer is private or public. The {service} in the name is the listing service of the offer. It could be either the product service that the offer is referencing, or a generic private offer parent service. We recommend that you don't build your integration to rely on the meaning of this {service} part. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEMENT_ACTIVE or ENTITLEMENT_PENDING_CANCELLATION, then this field is empty. * If the entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE, then this field is populated with the upcoming offer. * If the entitlement is in the state ENTITLEMENT_CANCELLED, then this is empty.
+  "newPendingOfferDuration": "A String", # Output only. The duration of the new offer, in ISO 8601 duration format. This field is populated for pending offer changes. It isn't populated for entitlements which aren't active yet. If the offer has a specified end date instead of a duration, this field is empty. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEMENT_ACTIVE, or ENTITLEMENT_PENDING_CANCELLATION, this field is empty. * If the entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE, and the upcoming offer doesn't have a specified end date, then this field is populated with the duration of the upcoming offer. Otherwise, this field is empty. * If the entitlement is in the state ENTITLEMENT_CANCELLED, then this field is empty.
   "newPendingPlan": "A String", # Output only. The identifier of the pending new plan. Required if the product has plans and the entitlement has a pending plan change.
-  "offer": "A String", # Output only. The name of the offer that was procured. Field is empty if order was not made using an offer. Format: 'projects/{project}/services/{service}/privateOffers/{offer}' OR 'projects/{project}/services/{service}/standardOffers/{offer}', depending on whether the offer is private or public. The {service} in the name is the listing service of the offer. It could be either the product service that the offer is referencing, or a generic private offer parent service. We recommend that you don't build your integration to rely on the meaning of this {service} part. * If the entitlement is in ENTITLEMENT_ACTIVATION_REQUESTED state, this field will be populated with the upcoming offer. * If the entitlement is in ENTITLEMENT_ACTIVE, ENTITLEMENT_PENDING_CANCELLATION, ENTITLEMENT_PENDING_PLAN_CHANGE, or ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state, this field will be populated with the current offer. * If the entitlement is in ENTITLEMENT_CANCELLED state, then this field will be populated with the latest offer the order was associated with.
-  "offerDuration": "A String", # Output only. The offer duration of the current offer in ISO 8601 duration format. Field is empty if entitlement was not made using an offer. If the offer has a specified end date instead of a duration, this field is empty. * If the entitlement is in ENTITLEMENT_ACTIVATION_REQUESTED state, then this field will be populated with the duration of the upcoming offer, if the upcoming offer does not have a specified end date. Otherwise, this field will be empty. * If the entitlement is in ENTITLEMENT_ACTIVE, ENTITLEMENT_PENDING_CANCELLATION, ENTITLEMENT_PENDING_PLAN_CHANGE, or ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state, then this field will be populated with the duration of the current offer if the current offer is does not have a specific end date. Otherwise, this field will be empty. * If the entitlement is in ENTITLEMENT_CANCELLED state, then this field will be populated with the duration of the latest offer the order was associated with if that offer does not have a specific end date. Otherwise, this field will be empty.
-  "offerEndTime": "A String", # Output only. End time for the Offer associated with this entitlement. Note that this field value can change over time. This occurs naturally even if the offer is not changed, due to auto renewal. * If the entitlement is in ENTITLEMENT_ACTIVATION_REQUESTED state, then: * If the entitlement is not yet approved, then this field will be populated with the expected end time of the upcoming offer (in the future) if the upcoming offer has a specified end date. Otherwise this field will be empty. * If the entitlement is approved, then this field will always be populated with the expected end time of the upcoming offer (in the future). This means both this field, and the offer_duration field, can co-exist. * If the entitlement is in ENTITLEMENT_ACTIVE or ENTITLEMENT_PENDING_CANCELLATION state, then this field will be populated with the actual expected end time of the current offer (in the futre). Meaning, this field will be set, regardless of whether the offer has a specific end date or a duration. This means both this field, and the offer_duration field, can co-exist. * If the entitlement is in ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE state: * If the current offer has already ended and became pure PAYG, then this field reflects the ACTUAL end time of the current offer (in the past). * Otherwise, then this is the EXPECTED end date of the current offer (in the future). * If the entitlement is in ENTITLEMENT_CANCELLED state, then this field will be populated with the ACTUAL end time of the latest offer the order was associated with (in the past). If the entitlement was cancelled before any offer started, then this field will be empty.
+  "offer": "A String", # Output only. The name of the offer that was procured. Field is empty if order wasn't made using an offer. Format: 'projects/{project}/services/{service}/privateOffers/{offer}' OR 'projects/{project}/services/{service}/standardOffers/{offer}', depending on whether the offer is private or public. The {service} in the name is the listing service of the offer. It could be either the product service that the offer is referencing, or a generic private offer parent service. We recommend that you don't build your integration to rely on the meaning of this {service} part. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, this field is populated with the upcoming offer. * If the entitlement is in the state ENTITLEMENT_ACTIVE, ENTITLEMENT_PENDING_CANCELLATION, ENTITLEMENT_PENDING_PLAN_CHANGE, or ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL, this field is populated with the current offer. * If the entitlement is in the state ENTITLEMENT_CANCELLED, then this field is populated with the latest offer that the order was associated with.
+  "offerDuration": "A String", # Output only. The offer duration of the current offer, in ISO 8601 duration format. This is empty if the entitlement wasn't made using an offer, or if the offer has a specified end date instead of a duration. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, and the upcoming offer doesn't have a specified end date, then this field is populated with the duration of the upcoming offer. Otherwise, this field is empty. * If the entitlement is in the state ENTITLEMENT_ACTIVE, ENTITLEMENT_PENDING_CANCELLATION, ENTITLEMENT_PENDING_PLAN_CHANGE, or ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL, and the current offer doesn't have a specified end date, then this field contains the duration of the current offer. Otherwise, this field is empty. * If the entitlement is in the state ENTITLEMENT_CANCELLED, and the offer doesn't have a specified end date, then this field is populated with the duration of the latest offer that the order was associated with. Otherwise, this field is empty.
+  "offerEndTime": "A String", # Output only. End time for the current term of the Offer associated with this entitlement. The value of this field can change naturally over time due to auto-renewal, even if the offer isn't changed. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, then: * If the entitlement isn't approved yet approved, and the offer has a specified end date, then this field is populated with the expected end time of the upcoming offer, in the future. Otherwise, this field is empty. * If the entitlement is approved, then this field is populated with the expected end time of the upcoming offer, in the future. This means that this field and the field offer_duration can both exist. * If the entitlement is in the state ENTITLEMENT_ACTIVE or ENTITLEMENT_PENDING_CANCELLATION, then this field is populated with the expected end time of the current offer, in the future. This field's value is set regardless of whether the offer has a specific end date or a duration. This means that this field and the field offer_duration can both exist. * If the entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE: * If the entitlement's pricing model is usage based and the associated offer is a private offer whose term has ended, then this field reflects the ACTUAL end time of the entitlement's associated offer (in the past), even though the entitlement associated with this private offer does not terminate at the end of that private offer's term. * Otherwise, this is the expected end date of the current offer, in the future. * If the entitlement is in the state ENTITLEMENT_CANCELLED, then this field is populated with the end time, in the past, of the latest offer that the order was associated with. If the entitlement was cancelled before any offer started, then this field is empty.
   "orderId": "A String", # Output only. The order ID of this entitlement, without any `orders/` resource name prefix.
   "plan": "A String", # Output only. The identifier of the plan that was procured. Required if the product has plans.
   "product": "A String", # Output only. The identifier of the entity that was purchased. This may actually represent a product, quote, or offer. We strongly recommend that you use the following more explicit fields: productExternalName, quoteExternalName, or offer.
@@ -361,14 +361,14 @@ 
Method Details

   },
   "messageToUser": "A String", # Provider-supplied message that is displayed to the end user. Currently this is used to communicate progress and ETA for provisioning. This field can be updated only when a user is waiting for an action from the provider, i.e. entitlement state is EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED or EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL. This field is cleared automatically when the entitlement state changes.
   "name": "A String", # Output only. The resource name of the entitlement. Entitlement names have the form `providers/{provider_id}/entitlements/{entitlement_id}`.
-  "newOfferEndTime": "A String", # Output only. The end time of the new offer. If the offer was has a term duration instead of a specified end date, this field is empty. This field is populated even if the entitlement isn't active yet. If there's no upcoming offer, the field is empty. * If the entitlement is in ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEMENT_ACTIVE, or ENTITLEMENT_PENDING_CANCELLATION state, then this field will be empty. * If the entitlement is in ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE state, then this field will be populated with the expected end time of the upcoming offer (in the future) if the upcoming offer has a specified end date. Otherwise, this field will be empty. * If the entitlement is in ENTITLEMENT_CANCELLED state, then this field will be empty.
-  "newOfferStartTime": "A String", # Output only. The timestamp when the new offer becomes effective. This field is populated even if the entitlement isn't active yet. If there's no upcoming offer, the field is empty. * If the entitlement is in ENTITLEMENT_ACTIVATION_REQUESTED state, this field will not be populated when the entitlement is not yet approved. But after the entitlement is approved, then this field will be populated with effective time of the upcoming offer. * If the entitlement is in ENTITLEMENT_ACTIVE or ENTITLEMENT_PENDING_CANCELLATION state, this field will not be populated. * If the entitlement is in ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state, this field will not be populated since the entitlement change is waiting on approval. * If the entitlement is in ENTITLEMENT_PENDING_PLAN_CHANGE state, this field will be populated with the expected effective time of the upcoming offer (in the future). * If the entitlement is in ENTITLEMENT_CANCELLED state, then this field will be empty.
-  "newPendingOffer": "A String", # Output only. The name of the offer the entitlement is switching to upon a pending plan change. Only exists if the pending plan change is moving to an offer. This field isn't populated for entitlements which aren't active yet. Format: 'projects/{project}/services/{service}/privateOffers/{offer}' OR 'projects/{project}/services/{service}/standardOffers/{offer}', depending on whether the offer is private or public. The {service} in the name is the listing service of the offer. It could be either the product service that the offer is referencing, or a generic private offer parent service. We recommend that you don't build your integration to rely on the meaning of this {service} part. * If the entitlement is in ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEMENT_ACTIVE or ENTITLEMENT_PENDING_CANCELLATION state, then this field will be empty. * If the entitlement is in ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE state, then this field will be populated with the upcoming offer. * If the entitlement is in ENTITLEMENT_CANCELLED state, then this will be empty.
-  "newPendingOfferDuration": "A String", # Output only. The duration of the new offer, in ISO 8601 duration format. This field isn't populated for entitlements which aren't active yet, only for pending offer changes. If the offer was has a specified end date instead of a duration, this field is empty. * If the entitlement is in ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEENTITLEMENT_ACTIVE, or ENTITLEMENT_PENDING_CANCELLATION state, then this field is empty. * If the entitlement is in ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE state, then this field will be populated with the duration of the upcoming offer, if the upcoming offer is does not have a specified end date. Otherwise, this field will be empty. * If the entitlement is in ENTITLEMENT_CANCELLED state, then this field will be empty.
+  "newOfferEndTime": "A String", # Output only. The end time of the new offer, determined from the offer's specified end date. If the offer des not have a specified end date then this field is not set. This field is populated even if the entitlement isn't active yet. If there's no upcoming offer, the field is empty. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEMENT_ACTIVE, or ENTITLEMENT_PENDING_CANCELLATION, then this field is empty. * If the entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE, and the upcoming offer has a specified end date, then this field is populated with the expected end time of the upcoming offer, in the future. Otherwise, this field is empty. * If the entitlement is in the state ENTITLEMENT_CANCELLED, then this field is empty.
+  "newOfferStartTime": "A String", # Output only. The timestamp when the new offer becomes effective. This field is populated even if the entitlement isn't active yet. If there's no upcoming offer, the field is empty. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, this field isn't populated when the entitlement isn't yet approved. After the entitlement is approved, this field is populated with the effective time of the upcoming offer. * If the entitlement is in the state ENTITLEMENT_ACTIVE or ENTITLEMENT_PENDING_CANCELLATION, this field isn't populated. * If the entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL, this field isn't populated, because the entitlement change is waiting on approval. * If the entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE, this field is populated with the expected effective time of the upcoming offer, which is in the future. * If the entitlement is in the state ENTITLEMENT_CANCELLED, then this field is empty.
+  "newPendingOffer": "A String", # Output only. Upon a pending plan change, the name of the offer that the entitlement is switching to. Only exists if the pending plan change is moving to an offer. This field isn't populated for entitlements which aren't active yet. Format: 'projects/{project}/services/{service}/privateOffers/{offer}' OR 'projects/{project}/services/{service}/standardOffers/{offer}', depending on whether the offer is private or public. The {service} in the name is the listing service of the offer. It could be either the product service that the offer is referencing, or a generic private offer parent service. We recommend that you don't build your integration to rely on the meaning of this {service} part. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEMENT_ACTIVE or ENTITLEMENT_PENDING_CANCELLATION, then this field is empty. * If the entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE, then this field is populated with the upcoming offer. * If the entitlement is in the state ENTITLEMENT_CANCELLED, then this is empty.
+  "newPendingOfferDuration": "A String", # Output only. The duration of the new offer, in ISO 8601 duration format. This field is populated for pending offer changes. It isn't populated for entitlements which aren't active yet. If the offer has a specified end date instead of a duration, this field is empty. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEMENT_ACTIVE, or ENTITLEMENT_PENDING_CANCELLATION, this field is empty. * If the entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE, and the upcoming offer doesn't have a specified end date, then this field is populated with the duration of the upcoming offer. Otherwise, this field is empty. * If the entitlement is in the state ENTITLEMENT_CANCELLED, then this field is empty.
   "newPendingPlan": "A String", # Output only. The identifier of the pending new plan. Required if the product has plans and the entitlement has a pending plan change.
-  "offer": "A String", # Output only. The name of the offer that was procured. Field is empty if order was not made using an offer. Format: 'projects/{project}/services/{service}/privateOffers/{offer}' OR 'projects/{project}/services/{service}/standardOffers/{offer}', depending on whether the offer is private or public. The {service} in the name is the listing service of the offer. It could be either the product service that the offer is referencing, or a generic private offer parent service. We recommend that you don't build your integration to rely on the meaning of this {service} part. * If the entitlement is in ENTITLEMENT_ACTIVATION_REQUESTED state, this field will be populated with the upcoming offer. * If the entitlement is in ENTITLEMENT_ACTIVE, ENTITLEMENT_PENDING_CANCELLATION, ENTITLEMENT_PENDING_PLAN_CHANGE, or ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state, this field will be populated with the current offer. * If the entitlement is in ENTITLEMENT_CANCELLED state, then this field will be populated with the latest offer the order was associated with.
-  "offerDuration": "A String", # Output only. The offer duration of the current offer in ISO 8601 duration format. Field is empty if entitlement was not made using an offer. If the offer has a specified end date instead of a duration, this field is empty. * If the entitlement is in ENTITLEMENT_ACTIVATION_REQUESTED state, then this field will be populated with the duration of the upcoming offer, if the upcoming offer does not have a specified end date. Otherwise, this field will be empty. * If the entitlement is in ENTITLEMENT_ACTIVE, ENTITLEMENT_PENDING_CANCELLATION, ENTITLEMENT_PENDING_PLAN_CHANGE, or ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state, then this field will be populated with the duration of the current offer if the current offer is does not have a specific end date. Otherwise, this field will be empty. * If the entitlement is in ENTITLEMENT_CANCELLED state, then this field will be populated with the duration of the latest offer the order was associated with if that offer does not have a specific end date. Otherwise, this field will be empty.
-  "offerEndTime": "A String", # Output only. End time for the Offer associated with this entitlement. Note that this field value can change over time. This occurs naturally even if the offer is not changed, due to auto renewal. * If the entitlement is in ENTITLEMENT_ACTIVATION_REQUESTED state, then: * If the entitlement is not yet approved, then this field will be populated with the expected end time of the upcoming offer (in the future) if the upcoming offer has a specified end date. Otherwise this field will be empty. * If the entitlement is approved, then this field will always be populated with the expected end time of the upcoming offer (in the future). This means both this field, and the offer_duration field, can co-exist. * If the entitlement is in ENTITLEMENT_ACTIVE or ENTITLEMENT_PENDING_CANCELLATION state, then this field will be populated with the actual expected end time of the current offer (in the futre). Meaning, this field will be set, regardless of whether the offer has a specific end date or a duration. This means both this field, and the offer_duration field, can co-exist. * If the entitlement is in ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE state: * If the current offer has already ended and became pure PAYG, then this field reflects the ACTUAL end time of the current offer (in the past). * Otherwise, then this is the EXPECTED end date of the current offer (in the future). * If the entitlement is in ENTITLEMENT_CANCELLED state, then this field will be populated with the ACTUAL end time of the latest offer the order was associated with (in the past). If the entitlement was cancelled before any offer started, then this field will be empty.
+  "offer": "A String", # Output only. The name of the offer that was procured. Field is empty if order wasn't made using an offer. Format: 'projects/{project}/services/{service}/privateOffers/{offer}' OR 'projects/{project}/services/{service}/standardOffers/{offer}', depending on whether the offer is private or public. The {service} in the name is the listing service of the offer. It could be either the product service that the offer is referencing, or a generic private offer parent service. We recommend that you don't build your integration to rely on the meaning of this {service} part. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, this field is populated with the upcoming offer. * If the entitlement is in the state ENTITLEMENT_ACTIVE, ENTITLEMENT_PENDING_CANCELLATION, ENTITLEMENT_PENDING_PLAN_CHANGE, or ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL, this field is populated with the current offer. * If the entitlement is in the state ENTITLEMENT_CANCELLED, then this field is populated with the latest offer that the order was associated with.
+  "offerDuration": "A String", # Output only. The offer duration of the current offer, in ISO 8601 duration format. This is empty if the entitlement wasn't made using an offer, or if the offer has a specified end date instead of a duration. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, and the upcoming offer doesn't have a specified end date, then this field is populated with the duration of the upcoming offer. Otherwise, this field is empty. * If the entitlement is in the state ENTITLEMENT_ACTIVE, ENTITLEMENT_PENDING_CANCELLATION, ENTITLEMENT_PENDING_PLAN_CHANGE, or ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL, and the current offer doesn't have a specified end date, then this field contains the duration of the current offer. Otherwise, this field is empty. * If the entitlement is in the state ENTITLEMENT_CANCELLED, and the offer doesn't have a specified end date, then this field is populated with the duration of the latest offer that the order was associated with. Otherwise, this field is empty.
+  "offerEndTime": "A String", # Output only. End time for the current term of the Offer associated with this entitlement. The value of this field can change naturally over time due to auto-renewal, even if the offer isn't changed. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, then: * If the entitlement isn't approved yet approved, and the offer has a specified end date, then this field is populated with the expected end time of the upcoming offer, in the future. Otherwise, this field is empty. * If the entitlement is approved, then this field is populated with the expected end time of the upcoming offer, in the future. This means that this field and the field offer_duration can both exist. * If the entitlement is in the state ENTITLEMENT_ACTIVE or ENTITLEMENT_PENDING_CANCELLATION, then this field is populated with the expected end time of the current offer, in the future. This field's value is set regardless of whether the offer has a specific end date or a duration. This means that this field and the field offer_duration can both exist. * If the entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE: * If the entitlement's pricing model is usage based and the associated offer is a private offer whose term has ended, then this field reflects the ACTUAL end time of the entitlement's associated offer (in the past), even though the entitlement associated with this private offer does not terminate at the end of that private offer's term. * Otherwise, this is the expected end date of the current offer, in the future. * If the entitlement is in the state ENTITLEMENT_CANCELLED, then this field is populated with the end time, in the past, of the latest offer that the order was associated with. If the entitlement was cancelled before any offer started, then this field is empty.
   "orderId": "A String", # Output only. The order ID of this entitlement, without any `orders/` resource name prefix.
   "plan": "A String", # Output only. The identifier of the plan that was procured. Required if the product has plans.
   "product": "A String", # Output only. The identifier of the entity that was purchased. This may actually represent a product, quote, or offer. We strongly recommend that you use the following more explicit fields: productExternalName, quoteExternalName, or offer.
diff --git a/docs/dyn/cloudtasks_v2.projects.locations.html b/docs/dyn/cloudtasks_v2.projects.locations.html
index 76b6b804e51..56e80ad1676 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. 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/cloudtasks_v2.projects.locations.queues.html b/docs/dyn/cloudtasks_v2.projects.locations.queues.html
index e7c379b6098..c816570f1d7 100644
--- a/docs/dyn/cloudtasks_v2.projects.locations.queues.html
+++ b/docs/dyn/cloudtasks_v2.projects.locations.queues.html
@@ -163,7 +163,7 @@ 
Method Details

       "pathOverride": { # PathOverride. Path message defines path override for HTTP targets. # URI path. When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment.
         "path": "A String", # The URI path (e.g., /users/1234). Default is an empty string.
       },
-      "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
+      "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI "https://www.example.com/example" and port=123, the overridden URI becomes "https://www.example.com:123/example". Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
       "queryOverride": { # QueryOverride. Query message defines query override for HTTP targets. # URI query. When specified, replaces the query part of the task URI. Setting the query value to an empty string clears the URI query segment.
         "queryParams": "A String", # The query parameters (e.g., qparam1=123&qparam2=456). Default is an empty string.
       },
@@ -229,7 +229,7 @@ 
Method Details

       "pathOverride": { # PathOverride. Path message defines path override for HTTP targets. # URI path. When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment.
         "path": "A String", # The URI path (e.g., /users/1234). Default is an empty string.
       },
-      "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
+      "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI "https://www.example.com/example" and port=123, the overridden URI becomes "https://www.example.com:123/example". Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
       "queryOverride": { # QueryOverride. Query message defines query override for HTTP targets. # URI query. When specified, replaces the query part of the task URI. Setting the query value to an empty string clears the URI query segment.
         "queryParams": "A String", # The query parameters (e.g., qparam1=123&qparam2=456). Default is an empty string.
       },
@@ -320,7 +320,7 @@ 
Method Details

       "pathOverride": { # PathOverride. Path message defines path override for HTTP targets. # URI path. When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment.
         "path": "A String", # The URI path (e.g., /users/1234). Default is an empty string.
       },
-      "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
+      "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI "https://www.example.com/example" and port=123, the overridden URI becomes "https://www.example.com:123/example". Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
       "queryOverride": { # QueryOverride. Query message defines query override for HTTP targets. # URI query. When specified, replaces the query part of the task URI. Setting the query value to an empty string clears the URI query segment.
         "queryParams": "A String", # The query parameters (e.g., qparam1=123&qparam2=456). Default is an empty string.
       },
@@ -442,7 +442,7 @@ 
Method Details

           "pathOverride": { # PathOverride. Path message defines path override for HTTP targets. # URI path. When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment.
             "path": "A String", # The URI path (e.g., /users/1234). Default is an empty string.
           },
-          "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
+          "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI "https://www.example.com/example" and port=123, the overridden URI becomes "https://www.example.com:123/example". Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
           "queryOverride": { # QueryOverride. Query message defines query override for HTTP targets. # URI query. When specified, replaces the query part of the task URI. Setting the query value to an empty string clears the URI query segment.
             "queryParams": "A String", # The query parameters (e.g., qparam1=123&qparam2=456). Default is an empty string.
           },
@@ -526,7 +526,7 @@ 
Method Details

       "pathOverride": { # PathOverride. Path message defines path override for HTTP targets. # URI path. When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment.
         "path": "A String", # The URI path (e.g., /users/1234). Default is an empty string.
       },
-      "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
+      "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI "https://www.example.com/example" and port=123, the overridden URI becomes "https://www.example.com:123/example". Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
       "queryOverride": { # QueryOverride. Query message defines query override for HTTP targets. # URI query. When specified, replaces the query part of the task URI. Setting the query value to an empty string clears the URI query segment.
         "queryParams": "A String", # The query parameters (e.g., qparam1=123&qparam2=456). Default is an empty string.
       },
@@ -593,7 +593,7 @@ 
Method Details

       "pathOverride": { # PathOverride. Path message defines path override for HTTP targets. # URI path. When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment.
         "path": "A String", # The URI path (e.g., /users/1234). Default is an empty string.
       },
-      "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
+      "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI "https://www.example.com/example" and port=123, the overridden URI becomes "https://www.example.com:123/example". Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
       "queryOverride": { # QueryOverride. Query message defines query override for HTTP targets. # URI query. When specified, replaces the query part of the task URI. Setting the query value to an empty string clears the URI query segment.
         "queryParams": "A String", # The query parameters (e.g., qparam1=123&qparam2=456). Default is an empty string.
       },
@@ -672,7 +672,7 @@ 
Method Details

       "pathOverride": { # PathOverride. Path message defines path override for HTTP targets. # URI path. When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment.
         "path": "A String", # The URI path (e.g., /users/1234). Default is an empty string.
       },
-      "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
+      "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI "https://www.example.com/example" and port=123, the overridden URI becomes "https://www.example.com:123/example". Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
       "queryOverride": { # QueryOverride. Query message defines query override for HTTP targets. # URI query. When specified, replaces the query part of the task URI. Setting the query value to an empty string clears the URI query segment.
         "queryParams": "A String", # The query parameters (e.g., qparam1=123&qparam2=456). Default is an empty string.
       },
@@ -751,7 +751,7 @@ 
Method Details

       "pathOverride": { # PathOverride. Path message defines path override for HTTP targets. # URI path. When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment.
         "path": "A String", # The URI path (e.g., /users/1234). Default is an empty string.
       },
-      "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
+      "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI "https://www.example.com/example" and port=123, the overridden URI becomes "https://www.example.com:123/example". Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
       "queryOverride": { # QueryOverride. Query message defines query override for HTTP targets. # URI query. When specified, replaces the query part of the task URI. Setting the query value to an empty string clears the URI query segment.
         "queryParams": "A String", # The query parameters (e.g., qparam1=123&qparam2=456). Default is an empty string.
       },
@@ -830,7 +830,7 @@ 
Method Details

       "pathOverride": { # PathOverride. Path message defines path override for HTTP targets. # URI path. When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment.
         "path": "A String", # The URI path (e.g., /users/1234). Default is an empty string.
       },
-      "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
+      "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI "https://www.example.com/example" and port=123, the overridden URI becomes "https://www.example.com:123/example". Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
       "queryOverride": { # QueryOverride. Query message defines query override for HTTP targets. # URI query. When specified, replaces the query part of the task URI. Setting the query value to an empty string clears the URI query segment.
         "queryParams": "A String", # The query parameters (e.g., qparam1=123&qparam2=456). Default is an empty string.
       },
diff --git a/docs/dyn/cloudtasks_v2.projects.locations.queues.tasks.html b/docs/dyn/cloudtasks_v2.projects.locations.queues.tasks.html
index dc5f706f82d..11e72a2a172 100644
--- a/docs/dyn/cloudtasks_v2.projects.locations.queues.tasks.html
+++ b/docs/dyn/cloudtasks_v2.projects.locations.queues.tasks.html
@@ -88,7 +88,7 @@ 
Instance Methods

 
Deletes a task. A task can be deleted if it is scheduled or dispatched. A task cannot be deleted if it has executed successfully or permanently failed.

 

   get(name, responseView=None, x__xgafv=None)

-
Gets a task.

+
Gets a task. After a task is successfully executed or has exhausted its retry attempts, the task is deleted. A `GetTask` request for a deleted task returns a `NOT_FOUND` error.

 

   list(parent, pageSize=None, pageToken=None, responseView=None, x__xgafv=None)

 
Lists the tasks in a queue. By default, only the BASIC view is retrieved due to performance considerations; response_view controls the subset of information which is returned. The tasks may be returned in any order. The ordering may change at any time.

@@ -216,7 +216,7 @@ 
Method Details

 
 { # Request message for CreateTask.
   "responseView": "A String", # The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Task resource.
-  "task": { # A unit of scheduled work. # Required. The task to add. Task names have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. The user can optionally specify a task name. If a name is not specified then the system will generate a random unique task id, which will be set in the task returned in the response. If schedule_time is not set or is in the past then Cloud Tasks will set it to the current time. Task De-duplication: Explicitly specifying a task ID enables task de-duplication. If a task's ID is identical to that of an existing task or a task that was deleted or executed recently then the call will fail with ALREADY_EXISTS. The IDs of deleted tasks are not immediately available for reuse. It can take up to 4 hours (or 9 days if the task's queue was created using a queue.yaml or queue.xml) for the task ID to be released and made available again. Because there is an extra lookup cost to identify duplicate task names, these CreateTask calls have significantly increased latency. Using hashed strings for the task id or for the prefix of the task id is recommended. Choosing task ids that are sequential or have sequential prefixes, for example using a timestamp, causes an increase in latency and error rates in all task commands. The infrastructure relies on an approximately uniform distribution of task ids to store and serve tasks efficiently.
+  "task": { # A unit of scheduled work. # Required. The task to add. Task names have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. The user can optionally specify a task name. If a name is not specified then the system will generate a random unique task id, which will be set in the task returned in the response. If schedule_time is not set or is in the past then Cloud Tasks will set it to the current time. Task De-duplication: Explicitly specifying a task ID enables task de-duplication. If a task's ID is identical to that of an existing task or a task that was deleted or executed recently then the call will fail with ALREADY_EXISTS. The IDs of deleted tasks are not immediately available for reuse. It can take up to 24 hours (or 9 days if the task's queue was created using a queue.yaml or queue.xml) for the task ID to be released and made available again. Because there is an extra lookup cost to identify duplicate task names, these CreateTask calls have significantly increased latency. Using hashed strings for the task id or for the prefix of the task id is recommended. Choosing task ids that are sequential or have sequential prefixes, for example using a timestamp, causes an increase in latency and error rates in all task commands. The infrastructure relies on an approximately uniform distribution of task ids to store and serve tasks efficiently.
     "appEngineHttpRequest": { # App Engine HTTP request. The message defines the HTTP request that is sent to an App Engine app when the task is dispatched. Using AppEngineHttpRequest requires [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) Google IAM permission for the project and the following scope: `https://www.googleapis.com/auth/cloud-platform` The task will be delivered to the App Engine app which belongs to the same project as the queue. For more information, see [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and how routing is affected by [dispatch files](https://cloud.google.com/appengine/docs/python/config/dispatchref). Traffic is encrypted during transport and never leaves Google datacenters. Because this traffic is carried over a communication mechanism internal to Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS). The request to the handler, however, will appear to have used the HTTP protocol. The AppEngineRouting used to construct the URL that the task is delivered to can be set at the queue-level or task-level: * If app_engine_routing_override is set on the queue, this value is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing. The `url` that the task will be sent to is: * `url =` host `+` relative_uri Tasks can be dispatched to secure app handlers, unsecure app handlers, and URIs restricted with [`login: admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref). Because tasks are not run as any user, they cannot be dispatched to URIs restricted with [`login: required`](https://cloud.google.com/appengine/docs/standard/python/config/appref) Task dispatches also do not follow redirects. The task attempt has succeeded if the app's request handler returns an HTTP response code in the range [`200` - `299`]. The task attempt has failed if the app's handler returns a non-2xx response code or Cloud Tasks does not receive response before the deadline. Failed tasks will be retried according to the retry configuration. `503` (Service Unavailable) is considered an App Engine system error instead of an application error and will cause Cloud Tasks' traffic congestion control to temporarily throttle the queue's dispatches. Unlike other types of task targets, a `429` (Too Many Requests) response from an app handler does not cause traffic congestion control to throttle the queue. # HTTP request that is sent to the App Engine app handler. An App Engine task is a task that has AppEngineHttpRequest set.
       "appEngineRouting": { # App Engine Routing. Defines routing characteristics specific to App Engine - service, version, and instance. For more information about services, versions, and instances see [An Overview of App Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine), [Microservices Architecture on Google App Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine), [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed), and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). Using AppEngineRouting requires [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) Google IAM permission for the project and the following scope: `https://www.googleapis.com/auth/cloud-platform` # Task-level setting for App Engine routing. * If app_engine_routing_override is set on the queue, this value is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing.
         "host": "A String", # Output only. The host that the task is sent to. The host is constructed from the domain name of the app associated with the queue's project ID (for example .appspot.com), and the service, version, and instance. Tasks which were created using the App Engine SDK might have a custom domain name. For more information, see [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
@@ -382,7 +382,7 @@ 
Method Details

 
 

     get(name, responseView=None, x__xgafv=None)
-  
Gets a task.
+  
Gets a task. After a task is successfully executed or has exhausted its retry attempts, the task is deleted. A `GetTask` request for a deleted task returns a `NOT_FOUND` error.
 
 Args:
   name: string, Required. The task name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` (required)
diff --git a/docs/dyn/cloudtasks_v2beta2.projects.locations.html b/docs/dyn/cloudtasks_v2beta2.projects.locations.html
index 442c094c58f..96ea061826f 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. 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/cloudtasks_v2beta2.projects.locations.queues.html b/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.html
index f8e9f93dd1e..b3d68229735 100644
--- a/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.html
+++ b/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.html
@@ -165,7 +165,7 @@ 
Method Details

       "pathOverride": { # PathOverride. Path message defines path override for HTTP targets. # URI path. When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment.
         "path": "A String", # The URI path (e.g., /users/1234). Default is an empty string.
       },
-      "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
+      "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI "https://www.example.com/example" and port=123, the overridden URI becomes "https://www.example.com:123/example". Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
       "queryOverride": { # QueryOverride. Query message defines query override for HTTP targets. # URI Query. When specified, replaces the query part of the task URI. Setting the query value to an empty string clears the URI query segment.
         "queryParams": "A String", # The query parameters (e.g., qparam1=123&qparam2=456). Default is an empty string.
       },
@@ -242,7 +242,7 @@ 
Method Details

       "pathOverride": { # PathOverride. Path message defines path override for HTTP targets. # URI path. When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment.
         "path": "A String", # The URI path (e.g., /users/1234). Default is an empty string.
       },
-      "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
+      "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI "https://www.example.com/example" and port=123, the overridden URI becomes "https://www.example.com:123/example". Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
       "queryOverride": { # QueryOverride. Query message defines query override for HTTP targets. # URI Query. When specified, replaces the query part of the task URI. Setting the query value to an empty string clears the URI query segment.
         "queryParams": "A String", # The query parameters (e.g., qparam1=123&qparam2=456). Default is an empty string.
       },
@@ -345,7 +345,7 @@ 
Method Details

       "pathOverride": { # PathOverride. Path message defines path override for HTTP targets. # URI path. When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment.
         "path": "A String", # The URI path (e.g., /users/1234). Default is an empty string.
       },
-      "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
+      "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI "https://www.example.com/example" and port=123, the overridden URI becomes "https://www.example.com:123/example". Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
       "queryOverride": { # QueryOverride. Query message defines query override for HTTP targets. # URI Query. When specified, replaces the query part of the task URI. Setting the query value to an empty string clears the URI query segment.
         "queryParams": "A String", # The query parameters (e.g., qparam1=123&qparam2=456). Default is an empty string.
       },
@@ -479,7 +479,7 @@ 
Method Details

           "pathOverride": { # PathOverride. Path message defines path override for HTTP targets. # URI path. When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment.
             "path": "A String", # The URI path (e.g., /users/1234). Default is an empty string.
           },
-          "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
+          "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI "https://www.example.com/example" and port=123, the overridden URI becomes "https://www.example.com:123/example". Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
           "queryOverride": { # QueryOverride. Query message defines query override for HTTP targets. # URI Query. When specified, replaces the query part of the task URI. Setting the query value to an empty string clears the URI query segment.
             "queryParams": "A String", # The query parameters (e.g., qparam1=123&qparam2=456). Default is an empty string.
           },
@@ -574,7 +574,7 @@ 
Method Details

       "pathOverride": { # PathOverride. Path message defines path override for HTTP targets. # URI path. When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment.
         "path": "A String", # The URI path (e.g., /users/1234). Default is an empty string.
       },
-      "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
+      "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI "https://www.example.com/example" and port=123, the overridden URI becomes "https://www.example.com:123/example". Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
       "queryOverride": { # QueryOverride. Query message defines query override for HTTP targets. # URI Query. When specified, replaces the query part of the task URI. Setting the query value to an empty string clears the URI query segment.
         "queryParams": "A String", # The query parameters (e.g., qparam1=123&qparam2=456). Default is an empty string.
       },
@@ -652,7 +652,7 @@ 
Method Details

       "pathOverride": { # PathOverride. Path message defines path override for HTTP targets. # URI path. When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment.
         "path": "A String", # The URI path (e.g., /users/1234). Default is an empty string.
       },
-      "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
+      "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI "https://www.example.com/example" and port=123, the overridden URI becomes "https://www.example.com:123/example". Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
       "queryOverride": { # QueryOverride. Query message defines query override for HTTP targets. # URI Query. When specified, replaces the query part of the task URI. Setting the query value to an empty string clears the URI query segment.
         "queryParams": "A String", # The query parameters (e.g., qparam1=123&qparam2=456). Default is an empty string.
       },
@@ -742,7 +742,7 @@ 
Method Details

       "pathOverride": { # PathOverride. Path message defines path override for HTTP targets. # URI path. When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment.
         "path": "A String", # The URI path (e.g., /users/1234). Default is an empty string.
       },
-      "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
+      "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI "https://www.example.com/example" and port=123, the overridden URI becomes "https://www.example.com:123/example". Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
       "queryOverride": { # QueryOverride. Query message defines query override for HTTP targets. # URI Query. When specified, replaces the query part of the task URI. Setting the query value to an empty string clears the URI query segment.
         "queryParams": "A String", # The query parameters (e.g., qparam1=123&qparam2=456). Default is an empty string.
       },
@@ -832,7 +832,7 @@ 
Method Details

       "pathOverride": { # PathOverride. Path message defines path override for HTTP targets. # URI path. When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment.
         "path": "A String", # The URI path (e.g., /users/1234). Default is an empty string.
       },
-      "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
+      "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI "https://www.example.com/example" and port=123, the overridden URI becomes "https://www.example.com:123/example". Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
       "queryOverride": { # QueryOverride. Query message defines query override for HTTP targets. # URI Query. When specified, replaces the query part of the task URI. Setting the query value to an empty string clears the URI query segment.
         "queryParams": "A String", # The query parameters (e.g., qparam1=123&qparam2=456). Default is an empty string.
       },
@@ -922,7 +922,7 @@ 
Method Details

       "pathOverride": { # PathOverride. Path message defines path override for HTTP targets. # URI path. When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment.
         "path": "A String", # The URI path (e.g., /users/1234). Default is an empty string.
       },
-      "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
+      "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI "https://www.example.com/example" and port=123, the overridden URI becomes "https://www.example.com:123/example". Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
       "queryOverride": { # QueryOverride. Query message defines query override for HTTP targets. # URI Query. When specified, replaces the query part of the task URI. Setting the query value to an empty string clears the URI query segment.
         "queryParams": "A String", # The query parameters (e.g., qparam1=123&qparam2=456). Default is an empty string.
       },
diff --git a/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.tasks.html b/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.tasks.html
index 0a36ecad56d..938d9c1606c 100644
--- a/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.tasks.html
+++ b/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.tasks.html
@@ -354,7 +354,7 @@ 
Method Details

 
 { # Request message for CreateTask.
   "responseView": "A String", # The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Task resource.
-  "task": { # A unit of scheduled work. # Required. The task to add. Task names have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. The user can optionally specify a task name. If a name is not specified then the system will generate a random unique task id, which will be set in the task returned in the response. If schedule_time is not set or is in the past then Cloud Tasks will set it to the current time. Task De-duplication: Explicitly specifying a task ID enables task de-duplication. If a task's ID is identical to that of an existing task or a task that was deleted or completed recently then the call will fail with ALREADY_EXISTS. The IDs of deleted tasks are not immediately available for reuse. It can take up to 4 hours (or 9 days if the task's queue was created using a queue.yaml or queue.xml) for the task ID to be released and made available again. Because there is an extra lookup cost to identify duplicate task names, these CreateTask calls have significantly increased latency. Using hashed strings for the task id or for the prefix of the task id is recommended. Choosing task ids that are sequential or have sequential prefixes, for example using a timestamp, causes an increase in latency and error rates in all task commands. The infrastructure relies on an approximately uniform distribution of task ids to store and serve tasks efficiently.
+  "task": { # A unit of scheduled work. # Required. The task to add. Task names have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. The user can optionally specify a task name. If a name is not specified then the system will generate a random unique task id, which will be set in the task returned in the response. If schedule_time is not set or is in the past then Cloud Tasks will set it to the current time. Task De-duplication: Explicitly specifying a task ID enables task de-duplication. If a task's ID is identical to that of an existing task or a task that was deleted or completed recently then the call will fail with ALREADY_EXISTS. The IDs of deleted tasks are not immediately available for reuse. It can take up to 24 hours (or 9 days if the task's queue was created using a queue.yaml or queue.xml) for the task ID to be released and made available again. Because there is an extra lookup cost to identify duplicate task names, these CreateTask calls have significantly increased latency. Using hashed strings for the task id or for the prefix of the task id is recommended. Choosing task ids that are sequential or have sequential prefixes, for example using a timestamp, causes an increase in latency and error rates in all task commands. The infrastructure relies on an approximately uniform distribution of task ids to store and serve tasks efficiently.
     "appEngineHttpRequest": { # App Engine HTTP request. The message defines the HTTP request that is sent to an App Engine app when the task is dispatched. This proto can only be used for tasks in a queue which has app_engine_http_target set. Using AppEngineHttpRequest requires [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) Google IAM permission for the project and the following scope: `https://www.googleapis.com/auth/cloud-platform` The task will be delivered to the App Engine app which belongs to the same project as the queue. For more information, see [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and how routing is affected by [dispatch files](https://cloud.google.com/appengine/docs/python/config/dispatchref). Traffic is encrypted during transport and never leaves Google datacenters. Because this traffic is carried over a communication mechanism internal to Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS). The request to the handler, however, will appear to have used the HTTP protocol. The AppEngineRouting used to construct the URL that the task is delivered to can be set at the queue-level or task-level: * If set, app_engine_routing_override is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing. The `url` that the task will be sent to is: * `url =` host `+` relative_url Tasks can be dispatched to secure app handlers, unsecure app handlers, and URIs restricted with [`login: admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref). Because tasks are not run as any user, they cannot be dispatched to URIs restricted with [`login: required`](https://cloud.google.com/appengine/docs/standard/python/config/appref) Task dispatches also do not follow redirects. The task attempt has succeeded if the app's request handler returns an HTTP response code in the range [`200` - `299`]. The task attempt has failed if the app's handler returns a non-2xx response code or Cloud Tasks does not receive response before the deadline. Failed tasks will be retried according to the retry configuration. `503` (Service Unavailable) is considered an App Engine system error instead of an application error and will cause Cloud Tasks' traffic congestion control to temporarily throttle the queue's dispatches. Unlike other types of task targets, a `429` (Too Many Requests) response from an app handler does not cause traffic congestion control to throttle the queue. # App Engine HTTP request that is sent to the task's target. Can be set only if app_engine_http_target is set on the queue. An App Engine task is a task that has AppEngineHttpRequest set.
       "appEngineRouting": { # App Engine Routing. Defines routing characteristics specific to App Engine - service, version, and instance. For more information about services, versions, and instances see [An Overview of App Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine), [Microservices Architecture on Google App Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine), [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed), and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). # Task-level setting for App Engine routing. If set, app_engine_routing_override is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing.
         "host": "A String", # Output only. The host that the task is sent to. For more information, see [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed). The host is constructed as: * `host = [application_domain_name]` `| [service] + '.' + [application_domain_name]` `| [version] + '.' + [application_domain_name]` `| [version_dot_service]+ '.' + [application_domain_name]` `| [instance] + '.' + [application_domain_name]` `| [instance_dot_service] + '.' + [application_domain_name]` `| [instance_dot_version] + '.' + [application_domain_name]` `| [instance_dot_version_dot_service] + '.' + [application_domain_name]` * `application_domain_name` = The domain name of the app, for example .appspot.com, which is associated with the queue's project ID. Some tasks which were created using the App Engine SDK use a custom domain name. * `service =` service * `version =` version * `version_dot_service =` version `+ '.' +` service * `instance =` instance * `instance_dot_service =` instance `+ '.' +` service * `instance_dot_version =` instance `+ '.' +` version * `instance_dot_version_dot_service =` instance `+ '.' +` version `+ '.' +` service If service is empty, then the task will be sent to the service which is the default service when the task is attempted. If version is empty, then the task will be sent to the version which is the default version when the task is attempted. If instance is empty, then the task will be sent to an instance which is available when the task is attempted. If service, version, or instance is invalid, then the task will be sent to the default version of the default service when the task is attempted.
diff --git a/docs/dyn/cloudtasks_v2beta3.projects.locations.html b/docs/dyn/cloudtasks_v2beta3.projects.locations.html
index cc40e87c8cd..3277c6634ba 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. 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/cloudtasks_v2beta3.projects.locations.queues.html b/docs/dyn/cloudtasks_v2beta3.projects.locations.queues.html
index 6d62fcba43a..526ff43e813 100644
--- a/docs/dyn/cloudtasks_v2beta3.projects.locations.queues.html
+++ b/docs/dyn/cloudtasks_v2beta3.projects.locations.queues.html
@@ -165,7 +165,7 @@ 
Method Details

       "pathOverride": { # PathOverride. Path message defines path override for HTTP targets. # URI path. When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment.
         "path": "A String", # The URI path (e.g., /users/1234). Default is an empty string.
       },
-      "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
+      "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI "https://www.example.com/example" and port=123, the overridden URI becomes "https://www.example.com:123/example". Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
       "queryOverride": { # QueryOverride. Query message defines query override for HTTP targets. # URI Query. When specified, replaces the query part of the task URI. Setting the query value to an empty string clears the URI query segment.
         "queryParams": "A String", # The query parameters (e.g., qparam1=123&qparam2=456). Default is an empty string.
       },
@@ -243,7 +243,7 @@ 
Method Details

       "pathOverride": { # PathOverride. Path message defines path override for HTTP targets. # URI path. When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment.
         "path": "A String", # The URI path (e.g., /users/1234). Default is an empty string.
       },
-      "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
+      "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI "https://www.example.com/example" and port=123, the overridden URI becomes "https://www.example.com:123/example". Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
       "queryOverride": { # QueryOverride. Query message defines query override for HTTP targets. # URI Query. When specified, replaces the query part of the task URI. Setting the query value to an empty string clears the URI query segment.
         "queryParams": "A String", # The query parameters (e.g., qparam1=123&qparam2=456). Default is an empty string.
       },
@@ -347,7 +347,7 @@ 
Method Details

       "pathOverride": { # PathOverride. Path message defines path override for HTTP targets. # URI path. When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment.
         "path": "A String", # The URI path (e.g., /users/1234). Default is an empty string.
       },
-      "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
+      "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI "https://www.example.com/example" and port=123, the overridden URI becomes "https://www.example.com:123/example". Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
       "queryOverride": { # QueryOverride. Query message defines query override for HTTP targets. # URI Query. When specified, replaces the query part of the task URI. Setting the query value to an empty string clears the URI query segment.
         "queryParams": "A String", # The query parameters (e.g., qparam1=123&qparam2=456). Default is an empty string.
       },
@@ -482,7 +482,7 @@ 
Method Details

           "pathOverride": { # PathOverride. Path message defines path override for HTTP targets. # URI path. When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment.
             "path": "A String", # The URI path (e.g., /users/1234). Default is an empty string.
           },
-          "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
+          "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI "https://www.example.com/example" and port=123, the overridden URI becomes "https://www.example.com:123/example". Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
           "queryOverride": { # QueryOverride. Query message defines query override for HTTP targets. # URI Query. When specified, replaces the query part of the task URI. Setting the query value to an empty string clears the URI query segment.
             "queryParams": "A String", # The query parameters (e.g., qparam1=123&qparam2=456). Default is an empty string.
           },
@@ -578,7 +578,7 @@ 
Method Details

       "pathOverride": { # PathOverride. Path message defines path override for HTTP targets. # URI path. When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment.
         "path": "A String", # The URI path (e.g., /users/1234). Default is an empty string.
       },
-      "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
+      "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI "https://www.example.com/example" and port=123, the overridden URI becomes "https://www.example.com:123/example". Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
       "queryOverride": { # QueryOverride. Query message defines query override for HTTP targets. # URI Query. When specified, replaces the query part of the task URI. Setting the query value to an empty string clears the URI query segment.
         "queryParams": "A String", # The query parameters (e.g., qparam1=123&qparam2=456). Default is an empty string.
       },
@@ -657,7 +657,7 @@ 
Method Details

       "pathOverride": { # PathOverride. Path message defines path override for HTTP targets. # URI path. When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment.
         "path": "A String", # The URI path (e.g., /users/1234). Default is an empty string.
       },
-      "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
+      "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI "https://www.example.com/example" and port=123, the overridden URI becomes "https://www.example.com:123/example". Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
       "queryOverride": { # QueryOverride. Query message defines query override for HTTP targets. # URI Query. When specified, replaces the query part of the task URI. Setting the query value to an empty string clears the URI query segment.
         "queryParams": "A String", # The query parameters (e.g., qparam1=123&qparam2=456). Default is an empty string.
       },
@@ -748,7 +748,7 @@ 
Method Details

       "pathOverride": { # PathOverride. Path message defines path override for HTTP targets. # URI path. When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment.
         "path": "A String", # The URI path (e.g., /users/1234). Default is an empty string.
       },
-      "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
+      "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI "https://www.example.com/example" and port=123, the overridden URI becomes "https://www.example.com:123/example". Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
       "queryOverride": { # QueryOverride. Query message defines query override for HTTP targets. # URI Query. When specified, replaces the query part of the task URI. Setting the query value to an empty string clears the URI query segment.
         "queryParams": "A String", # The query parameters (e.g., qparam1=123&qparam2=456). Default is an empty string.
       },
@@ -839,7 +839,7 @@ 
Method Details

       "pathOverride": { # PathOverride. Path message defines path override for HTTP targets. # URI path. When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment.
         "path": "A String", # The URI path (e.g., /users/1234). Default is an empty string.
       },
-      "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
+      "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI "https://www.example.com/example" and port=123, the overridden URI becomes "https://www.example.com:123/example". Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
       "queryOverride": { # QueryOverride. Query message defines query override for HTTP targets. # URI Query. When specified, replaces the query part of the task URI. Setting the query value to an empty string clears the URI query segment.
         "queryParams": "A String", # The query parameters (e.g., qparam1=123&qparam2=456). Default is an empty string.
       },
@@ -930,7 +930,7 @@ 
Method Details

       "pathOverride": { # PathOverride. Path message defines path override for HTTP targets. # URI path. When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment.
         "path": "A String", # The URI path (e.g., /users/1234). Default is an empty string.
       },
-      "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
+      "port": "A String", # Port override. When specified, replaces the port part of the task URI. For instance, for a URI "https://www.example.com/example" and port=123, the overridden URI becomes "https://www.example.com:123/example". Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
       "queryOverride": { # QueryOverride. Query message defines query override for HTTP targets. # URI Query. When specified, replaces the query part of the task URI. Setting the query value to an empty string clears the URI query segment.
         "queryParams": "A String", # The query parameters (e.g., qparam1=123&qparam2=456). Default is an empty string.
       },
diff --git a/docs/dyn/cloudtasks_v2beta3.projects.locations.queues.tasks.html b/docs/dyn/cloudtasks_v2beta3.projects.locations.queues.tasks.html
index 4aad1b8af24..f8ddca43f2a 100644
--- a/docs/dyn/cloudtasks_v2beta3.projects.locations.queues.tasks.html
+++ b/docs/dyn/cloudtasks_v2beta3.projects.locations.queues.tasks.html
@@ -88,7 +88,7 @@ 
Instance Methods

 
Deletes a task. A task can be deleted if it is scheduled or dispatched. A task cannot be deleted if it has executed successfully or permanently failed.

 

   get(name, responseView=None, x__xgafv=None)

-
Gets a task.

+
Gets a task. After a task is successfully executed or has exhausted its retry attempts, the task is deleted. A `GetTask` request for a deleted task returns a `NOT_FOUND` error.

 

   list(parent, pageSize=None, pageToken=None, responseView=None, x__xgafv=None)

 
Lists the tasks in a queue. By default, only the BASIC view is retrieved due to performance considerations; response_view controls the subset of information which is returned. The tasks may be returned in any order. The ordering may change at any time.

@@ -220,7 +220,7 @@ 
Method Details

 
 { # Request message for CreateTask.
   "responseView": "A String", # The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Task resource.
-  "task": { # A unit of scheduled work. # Required. The task to add. Task names have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. The user can optionally specify a task name. If a name is not specified then the system will generate a random unique task id, which will be set in the task returned in the response. If schedule_time is not set or is in the past then Cloud Tasks will set it to the current time. Task De-duplication: Explicitly specifying a task ID enables task de-duplication. If a task's ID is identical to that of an existing task or a task that was deleted or executed recently then the call will fail with ALREADY_EXISTS. The IDs of deleted tasks are not immediately available for reuse. It can take up to 4 hours (or 9 days if the task's queue was created using a queue.yaml or queue.xml) for the task ID to be released and made available again. Because there is an extra lookup cost to identify duplicate task names, these CreateTask calls have significantly increased latency. Using hashed strings for the task id or for the prefix of the task id is recommended. Choosing task ids that are sequential or have sequential prefixes, for example using a timestamp, causes an increase in latency and error rates in all task commands. The infrastructure relies on an approximately uniform distribution of task ids to store and serve tasks efficiently.
+  "task": { # A unit of scheduled work. # Required. The task to add. Task names have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. The user can optionally specify a task name. If a name is not specified then the system will generate a random unique task id, which will be set in the task returned in the response. If schedule_time is not set or is in the past then Cloud Tasks will set it to the current time. Task De-duplication: Explicitly specifying a task ID enables task de-duplication. If a task's ID is identical to that of an existing task or a task that was deleted or executed recently then the call will fail with ALREADY_EXISTS. The IDs of deleted tasks are not immediately available for reuse. It can take up to 24 hours (or 9 days if the task's queue was created using a queue.yaml or queue.xml) for the task ID to be released and made available again. Because there is an extra lookup cost to identify duplicate task names, these CreateTask calls have significantly increased latency. Using hashed strings for the task id or for the prefix of the task id is recommended. Choosing task ids that are sequential or have sequential prefixes, for example using a timestamp, causes an increase in latency and error rates in all task commands. The infrastructure relies on an approximately uniform distribution of task ids to store and serve tasks efficiently.
     "appEngineHttpRequest": { # App Engine HTTP request. The message defines the HTTP request that is sent to an App Engine app when the task is dispatched. Using AppEngineHttpRequest requires [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) Google IAM permission for the project and the following scope: `https://www.googleapis.com/auth/cloud-platform` The task will be delivered to the App Engine app which belongs to the same project as the queue. For more information, see [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and how routing is affected by [dispatch files](https://cloud.google.com/appengine/docs/python/config/dispatchref). Traffic is encrypted during transport and never leaves Google datacenters. Because this traffic is carried over a communication mechanism internal to Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS). The request to the handler, however, will appear to have used the HTTP protocol. The AppEngineRouting used to construct the URL that the task is delivered to can be set at the queue-level or task-level: * If set, app_engine_routing_override is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing. The `url` that the task will be sent to is: * `url =` host `+` relative_uri Tasks can be dispatched to secure app handlers, unsecure app handlers, and URIs restricted with [`login: admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref). Because tasks are not run as any user, they cannot be dispatched to URIs restricted with [`login: required`](https://cloud.google.com/appengine/docs/standard/python/config/appref) Task dispatches also do not follow redirects. The task attempt has succeeded if the app's request handler returns an HTTP response code in the range [`200` - `299`]. The task attempt has failed if the app's handler returns a non-2xx response code or Cloud Tasks does not receive response before the deadline. Failed tasks will be retried according to the retry configuration. `503` (Service Unavailable) is considered an App Engine system error instead of an application error and will cause Cloud Tasks' traffic congestion control to temporarily throttle the queue's dispatches. Unlike other types of task targets, a `429` (Too Many Requests) response from an app handler does not cause traffic congestion control to throttle the queue. # HTTP request that is sent to the App Engine app handler. An App Engine task is a task that has AppEngineHttpRequest set.
       "appEngineRouting": { # App Engine Routing. Defines routing characteristics specific to App Engine - service, version, and instance. For more information about services, versions, and instances see [An Overview of App Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine), [Microservices Architecture on Google App Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine), [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed), and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). # Task-level setting for App Engine routing. If set, app_engine_routing_override is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing.
         "host": "A String", # Output only. The host that the task is sent to. The host is constructed from the domain name of the app associated with the queue's project ID (for example .appspot.com), and the service, version, and instance. Tasks which were created using the App Engine SDK might have a custom domain name. For more information, see [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
@@ -394,7 +394,7 @@ 
Method Details

 
 

     get(name, responseView=None, x__xgafv=None)
-  
Gets a task.
+  
Gets a task. After a task is successfully executed or has exhausted its retry attempts, the task is deleted. A `GetTask` request for a deleted task returns a `NOT_FOUND` error.
 
 Args:
   name: string, Required. The task name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` (required)
diff --git a/docs/dyn/connectors_v1.projects.locations.html b/docs/dyn/connectors_v1.projects.locations.html
index 7066c12ed3c..d0576eaa02e 100644
--- a/docs/dyn/connectors_v1.projects.locations.html
+++ b/docs/dyn/connectors_v1.projects.locations.html
@@ -222,7 +222,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  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)
+  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/contactcenteraiplatform_v1alpha1.projects.locations.html b/docs/dyn/contactcenteraiplatform_v1alpha1.projects.locations.html
index 02ba4e74d44..5491c4a1884 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. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (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/dataplex_v1.projects.locations.dataScans.html b/docs/dyn/dataplex_v1.projects.locations.dataScans.html
index cd69d4740f6..742dc08d3e9 100644
--- a/docs/dyn/dataplex_v1.projects.locations.dataScans.html
+++ b/docs/dyn/dataplex_v1.projects.locations.dataScans.html
@@ -130,11 +130,11 @@ 
Method Details

   body: object, The request body.
     The object takes the form of:
 
-{ # Represents a user-visible job which provides the insights for the related data source.For example: Data quality: generates queries based on the rules and runs against the data to get data quality check results. For more information, see Auto data quality overview (https://cloud.google.com/dataplex/docs/auto-data-quality-overview). Data profile: analyzes the data in tables and generates insights about the structure, content and relationships (such as null percent, cardinality, min/max/mean, etc). For more information, see About data profiling (https://cloud.google.com/dataplex/docs/data-profiling-overview). Data discovery: scans data in Cloud Storage buckets to extract and then catalog metadata. For more information, see Discover and catalog Cloud Storage data (https://cloud.google.com/bigquery/docs/automatic-discovery).
+{ # Represents a user-visible job which provides the insights for the related data source.For example: Data quality: generates queries based on the rules and runs against the data to get data quality check results. For more information, see Auto data quality overview (https://cloud.google.com/dataplex/docs/auto-data-quality-overview). Data profile: analyzes the data in tables and generates insights about the structure, content and relationships (such as null percent, cardinality, min/max/mean, etc). For more information, see About data profiling (https://cloud.google.com/dataplex/docs/data-profiling-overview). Data discovery: scans data in Cloud Storage buckets to extract and then catalog metadata. For more information, see Discover and catalog Cloud Storage data (https://cloud.google.com/bigquery/docs/automatic-discovery). Data documentation: analyzes the table details and generates insights including descriptions and sample SQL queries for the table. For more information, see Generate data insights in BigQuery (https://cloud.google.com/bigquery/docs/data-insights).
   "createTime": "A String", # Output only. The time when the scan was created.
   "data": { # The data source for DataScan. # Required. The data source for DataScan.
     "entity": "A String", # Immutable. The Dataplex Universal Catalog entity that represents the data source (e.g. BigQuery table) for DataScan, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}.
-    "resource": "A String", # Immutable. The service-qualified full resource name of the cloud resource for a DataScan job to scan against. The field could either be: Cloud Storage bucket for DataDiscoveryScan Format: //storage.googleapis.com/projects/PROJECT_ID/buckets/BUCKET_ID or BigQuery table of type "TABLE" for DataProfileScan/DataQualityScan Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID
+    "resource": "A String", # Immutable. The service-qualified full resource name of the cloud resource for a DataScan job to scan against. The field could either be: Cloud Storage bucket for DataDiscoveryScan Format: //storage.googleapis.com/projects/PROJECT_ID/buckets/BUCKET_ID or BigQuery table of type "TABLE" for DataProfileScan/DataQualityScan/DataDocumentationScan Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID
   },
   "dataDiscoveryResult": { # The output of a data discovery scan. # Output only. The result of a data discovery scan.
     "bigqueryPublishing": { # Describes BigQuery publishing configurations. # Output only. Configuration for metadata publishing.
@@ -180,6 +180,31 @@ 
Method Details

       },
     },
   },
+  "dataDocumentationResult": { # The output of a DataDocumentation scan. # Output only. The result of a data documentation scan.
+    "tableResult": { # Generated metadata about the table. # Output only. Table result for insights.
+      "name": "A String", # Output only. The service-qualified full resource name of the cloud resource. Ex: bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID
+      "overview": "A String", # Output only. Generated description of the table.
+      "queries": [ # Output only. Sample SQL queries for the table.
+        { # A sample SQL query in data documentation.
+          "description": "A String", # Output only. The description for the query.
+          "sql": "A String", # Output only. The SQL query string which can be executed.
+        },
+      ],
+      "schema": { # Schema of the table with generated metadata of columns. # Output only. Schema of the table with generated metadata of the columns in the schema.
+        "fields": [ # Output only. The list of columns.
+          { # Column of a table with generated metadata and nested fields.
+            "description": "A String", # Output only. Generated description for columns and fields.
+            "fields": [ # Output only. Nested fields.
+              # Object with schema name: GoogleCloudDataplexV1DataDocumentationResultField
+            ],
+            "name": "A String", # Output only. The name of the column.
+          },
+        ],
+      },
+    },
+  },
+  "dataDocumentationSpec": { # DataDocumentation scan related spec. # Settings for a data documentation scan.
+  },
   "dataProfileResult": { # DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result. # Output only. The result of a data profile scan.
     "postScanActionsResult": { # The result of post scan actions of DataProfileScan job. # Output only. The result of post scan actions.
       "bigqueryExportResult": { # The result of BigQuery export post scan action. # Output only. The result of BigQuery export post scan action.
@@ -609,11 +634,11 @@ 
Method Details

 Returns:
   An object of the form:
 
-    { # Represents a user-visible job which provides the insights for the related data source.For example: Data quality: generates queries based on the rules and runs against the data to get data quality check results. For more information, see Auto data quality overview (https://cloud.google.com/dataplex/docs/auto-data-quality-overview). Data profile: analyzes the data in tables and generates insights about the structure, content and relationships (such as null percent, cardinality, min/max/mean, etc). For more information, see About data profiling (https://cloud.google.com/dataplex/docs/data-profiling-overview). Data discovery: scans data in Cloud Storage buckets to extract and then catalog metadata. For more information, see Discover and catalog Cloud Storage data (https://cloud.google.com/bigquery/docs/automatic-discovery).
+    { # Represents a user-visible job which provides the insights for the related data source.For example: Data quality: generates queries based on the rules and runs against the data to get data quality check results. For more information, see Auto data quality overview (https://cloud.google.com/dataplex/docs/auto-data-quality-overview). Data profile: analyzes the data in tables and generates insights about the structure, content and relationships (such as null percent, cardinality, min/max/mean, etc). For more information, see About data profiling (https://cloud.google.com/dataplex/docs/data-profiling-overview). Data discovery: scans data in Cloud Storage buckets to extract and then catalog metadata. For more information, see Discover and catalog Cloud Storage data (https://cloud.google.com/bigquery/docs/automatic-discovery). Data documentation: analyzes the table details and generates insights including descriptions and sample SQL queries for the table. For more information, see Generate data insights in BigQuery (https://cloud.google.com/bigquery/docs/data-insights).
   "createTime": "A String", # Output only. The time when the scan was created.
   "data": { # The data source for DataScan. # Required. The data source for DataScan.
     "entity": "A String", # Immutable. The Dataplex Universal Catalog entity that represents the data source (e.g. BigQuery table) for DataScan, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}.
-    "resource": "A String", # Immutable. The service-qualified full resource name of the cloud resource for a DataScan job to scan against. The field could either be: Cloud Storage bucket for DataDiscoveryScan Format: //storage.googleapis.com/projects/PROJECT_ID/buckets/BUCKET_ID or BigQuery table of type "TABLE" for DataProfileScan/DataQualityScan Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID
+    "resource": "A String", # Immutable. The service-qualified full resource name of the cloud resource for a DataScan job to scan against. The field could either be: Cloud Storage bucket for DataDiscoveryScan Format: //storage.googleapis.com/projects/PROJECT_ID/buckets/BUCKET_ID or BigQuery table of type "TABLE" for DataProfileScan/DataQualityScan/DataDocumentationScan Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID
   },
   "dataDiscoveryResult": { # The output of a data discovery scan. # Output only. The result of a data discovery scan.
     "bigqueryPublishing": { # Describes BigQuery publishing configurations. # Output only. Configuration for metadata publishing.
@@ -659,6 +684,31 @@ 
Method Details

       },
     },
   },
+  "dataDocumentationResult": { # The output of a DataDocumentation scan. # Output only. The result of a data documentation scan.
+    "tableResult": { # Generated metadata about the table. # Output only. Table result for insights.
+      "name": "A String", # Output only. The service-qualified full resource name of the cloud resource. Ex: bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID
+      "overview": "A String", # Output only. Generated description of the table.
+      "queries": [ # Output only. Sample SQL queries for the table.
+        { # A sample SQL query in data documentation.
+          "description": "A String", # Output only. The description for the query.
+          "sql": "A String", # Output only. The SQL query string which can be executed.
+        },
+      ],
+      "schema": { # Schema of the table with generated metadata of columns. # Output only. Schema of the table with generated metadata of the columns in the schema.
+        "fields": [ # Output only. The list of columns.
+          { # Column of a table with generated metadata and nested fields.
+            "description": "A String", # Output only. Generated description for columns and fields.
+            "fields": [ # Output only. Nested fields.
+              # Object with schema name: GoogleCloudDataplexV1DataDocumentationResultField
+            ],
+            "name": "A String", # Output only. The name of the column.
+          },
+        ],
+      },
+    },
+  },
+  "dataDocumentationSpec": { # DataDocumentation scan related spec. # Settings for a data documentation scan.
+  },
   "dataProfileResult": { # DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result. # Output only. The result of a data profile scan.
     "postScanActionsResult": { # The result of post scan actions of DataProfileScan job. # Output only. The result of post scan actions.
       "bigqueryExportResult": { # The result of BigQuery export post scan action. # Output only. The result of BigQuery export post scan action.
@@ -1002,11 +1052,11 @@ 
Method Details

 
     { # List dataScans response.
   "dataScans": [ # DataScans (BASIC view only) under the given parent location.
-    { # Represents a user-visible job which provides the insights for the related data source.For example: Data quality: generates queries based on the rules and runs against the data to get data quality check results. For more information, see Auto data quality overview (https://cloud.google.com/dataplex/docs/auto-data-quality-overview). Data profile: analyzes the data in tables and generates insights about the structure, content and relationships (such as null percent, cardinality, min/max/mean, etc). For more information, see About data profiling (https://cloud.google.com/dataplex/docs/data-profiling-overview). Data discovery: scans data in Cloud Storage buckets to extract and then catalog metadata. For more information, see Discover and catalog Cloud Storage data (https://cloud.google.com/bigquery/docs/automatic-discovery).
+    { # Represents a user-visible job which provides the insights for the related data source.For example: Data quality: generates queries based on the rules and runs against the data to get data quality check results. For more information, see Auto data quality overview (https://cloud.google.com/dataplex/docs/auto-data-quality-overview). Data profile: analyzes the data in tables and generates insights about the structure, content and relationships (such as null percent, cardinality, min/max/mean, etc). For more information, see About data profiling (https://cloud.google.com/dataplex/docs/data-profiling-overview). Data discovery: scans data in Cloud Storage buckets to extract and then catalog metadata. For more information, see Discover and catalog Cloud Storage data (https://cloud.google.com/bigquery/docs/automatic-discovery). Data documentation: analyzes the table details and generates insights including descriptions and sample SQL queries for the table. For more information, see Generate data insights in BigQuery (https://cloud.google.com/bigquery/docs/data-insights).
       "createTime": "A String", # Output only. The time when the scan was created.
       "data": { # The data source for DataScan. # Required. The data source for DataScan.
         "entity": "A String", # Immutable. The Dataplex Universal Catalog entity that represents the data source (e.g. BigQuery table) for DataScan, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}.
-        "resource": "A String", # Immutable. The service-qualified full resource name of the cloud resource for a DataScan job to scan against. The field could either be: Cloud Storage bucket for DataDiscoveryScan Format: //storage.googleapis.com/projects/PROJECT_ID/buckets/BUCKET_ID or BigQuery table of type "TABLE" for DataProfileScan/DataQualityScan Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID
+        "resource": "A String", # Immutable. The service-qualified full resource name of the cloud resource for a DataScan job to scan against. The field could either be: Cloud Storage bucket for DataDiscoveryScan Format: //storage.googleapis.com/projects/PROJECT_ID/buckets/BUCKET_ID or BigQuery table of type "TABLE" for DataProfileScan/DataQualityScan/DataDocumentationScan Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID
       },
       "dataDiscoveryResult": { # The output of a data discovery scan. # Output only. The result of a data discovery scan.
         "bigqueryPublishing": { # Describes BigQuery publishing configurations. # Output only. Configuration for metadata publishing.
@@ -1052,6 +1102,31 @@ 
Method Details

           },
         },
       },
+      "dataDocumentationResult": { # The output of a DataDocumentation scan. # Output only. The result of a data documentation scan.
+        "tableResult": { # Generated metadata about the table. # Output only. Table result for insights.
+          "name": "A String", # Output only. The service-qualified full resource name of the cloud resource. Ex: bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID
+          "overview": "A String", # Output only. Generated description of the table.
+          "queries": [ # Output only. Sample SQL queries for the table.
+            { # A sample SQL query in data documentation.
+              "description": "A String", # Output only. The description for the query.
+              "sql": "A String", # Output only. The SQL query string which can be executed.
+            },
+          ],
+          "schema": { # Schema of the table with generated metadata of columns. # Output only. Schema of the table with generated metadata of the columns in the schema.
+            "fields": [ # Output only. The list of columns.
+              { # Column of a table with generated metadata and nested fields.
+                "description": "A String", # Output only. Generated description for columns and fields.
+                "fields": [ # Output only. Nested fields.
+                  # Object with schema name: GoogleCloudDataplexV1DataDocumentationResultField
+                ],
+                "name": "A String", # Output only. The name of the column.
+              },
+            ],
+          },
+        },
+      },
+      "dataDocumentationSpec": { # DataDocumentation scan related spec. # Settings for a data documentation scan.
+      },
       "dataProfileResult": { # DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result. # Output only. The result of a data profile scan.
         "postScanActionsResult": { # The result of post scan actions of DataProfileScan job. # Output only. The result of post scan actions.
           "bigqueryExportResult": { # The result of BigQuery export post scan action. # Output only. The result of BigQuery export post scan action.
@@ -1356,11 +1431,11 @@ 
Method Details

   body: object, The request body.
     The object takes the form of:
 
-{ # Represents a user-visible job which provides the insights for the related data source.For example: Data quality: generates queries based on the rules and runs against the data to get data quality check results. For more information, see Auto data quality overview (https://cloud.google.com/dataplex/docs/auto-data-quality-overview). Data profile: analyzes the data in tables and generates insights about the structure, content and relationships (such as null percent, cardinality, min/max/mean, etc). For more information, see About data profiling (https://cloud.google.com/dataplex/docs/data-profiling-overview). Data discovery: scans data in Cloud Storage buckets to extract and then catalog metadata. For more information, see Discover and catalog Cloud Storage data (https://cloud.google.com/bigquery/docs/automatic-discovery).
+{ # Represents a user-visible job which provides the insights for the related data source.For example: Data quality: generates queries based on the rules and runs against the data to get data quality check results. For more information, see Auto data quality overview (https://cloud.google.com/dataplex/docs/auto-data-quality-overview). Data profile: analyzes the data in tables and generates insights about the structure, content and relationships (such as null percent, cardinality, min/max/mean, etc). For more information, see About data profiling (https://cloud.google.com/dataplex/docs/data-profiling-overview). Data discovery: scans data in Cloud Storage buckets to extract and then catalog metadata. For more information, see Discover and catalog Cloud Storage data (https://cloud.google.com/bigquery/docs/automatic-discovery). Data documentation: analyzes the table details and generates insights including descriptions and sample SQL queries for the table. For more information, see Generate data insights in BigQuery (https://cloud.google.com/bigquery/docs/data-insights).
   "createTime": "A String", # Output only. The time when the scan was created.
   "data": { # The data source for DataScan. # Required. The data source for DataScan.
     "entity": "A String", # Immutable. The Dataplex Universal Catalog entity that represents the data source (e.g. BigQuery table) for DataScan, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}.
-    "resource": "A String", # Immutable. The service-qualified full resource name of the cloud resource for a DataScan job to scan against. The field could either be: Cloud Storage bucket for DataDiscoveryScan Format: //storage.googleapis.com/projects/PROJECT_ID/buckets/BUCKET_ID or BigQuery table of type "TABLE" for DataProfileScan/DataQualityScan Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID
+    "resource": "A String", # Immutable. The service-qualified full resource name of the cloud resource for a DataScan job to scan against. The field could either be: Cloud Storage bucket for DataDiscoveryScan Format: //storage.googleapis.com/projects/PROJECT_ID/buckets/BUCKET_ID or BigQuery table of type "TABLE" for DataProfileScan/DataQualityScan/DataDocumentationScan Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID
   },
   "dataDiscoveryResult": { # The output of a data discovery scan. # Output only. The result of a data discovery scan.
     "bigqueryPublishing": { # Describes BigQuery publishing configurations. # Output only. Configuration for metadata publishing.
@@ -1406,6 +1481,31 @@ 
Method Details

       },
     },
   },
+  "dataDocumentationResult": { # The output of a DataDocumentation scan. # Output only. The result of a data documentation scan.
+    "tableResult": { # Generated metadata about the table. # Output only. Table result for insights.
+      "name": "A String", # Output only. The service-qualified full resource name of the cloud resource. Ex: bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID
+      "overview": "A String", # Output only. Generated description of the table.
+      "queries": [ # Output only. Sample SQL queries for the table.
+        { # A sample SQL query in data documentation.
+          "description": "A String", # Output only. The description for the query.
+          "sql": "A String", # Output only. The SQL query string which can be executed.
+        },
+      ],
+      "schema": { # Schema of the table with generated metadata of columns. # Output only. Schema of the table with generated metadata of the columns in the schema.
+        "fields": [ # Output only. The list of columns.
+          { # Column of a table with generated metadata and nested fields.
+            "description": "A String", # Output only. Generated description for columns and fields.
+            "fields": [ # Output only. Nested fields.
+              # Object with schema name: GoogleCloudDataplexV1DataDocumentationResultField
+            ],
+            "name": "A String", # Output only. The name of the column.
+          },
+        ],
+      },
+    },
+  },
+  "dataDocumentationSpec": { # DataDocumentation scan related spec. # Settings for a data documentation scan.
+  },
   "dataProfileResult": { # DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result. # Output only. The result of a data profile scan.
     "postScanActionsResult": { # The result of post scan actions of DataProfileScan job. # Output only. The result of post scan actions.
       "bigqueryExportResult": { # The result of BigQuery export post scan action. # Output only. The result of BigQuery export post scan action.
@@ -1778,6 +1878,31 @@ 
Method Details

         },
       },
     },
+    "dataDocumentationResult": { # The output of a DataDocumentation scan. # Output only. The result of a data documentation scan.
+      "tableResult": { # Generated metadata about the table. # Output only. Table result for insights.
+        "name": "A String", # Output only. The service-qualified full resource name of the cloud resource. Ex: bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID
+        "overview": "A String", # Output only. Generated description of the table.
+        "queries": [ # Output only. Sample SQL queries for the table.
+          { # A sample SQL query in data documentation.
+            "description": "A String", # Output only. The description for the query.
+            "sql": "A String", # Output only. The SQL query string which can be executed.
+          },
+        ],
+        "schema": { # Schema of the table with generated metadata of columns. # Output only. Schema of the table with generated metadata of the columns in the schema.
+          "fields": [ # Output only. The list of columns.
+            { # Column of a table with generated metadata and nested fields.
+              "description": "A String", # Output only. Generated description for columns and fields.
+              "fields": [ # Output only. Nested fields.
+                # Object with schema name: GoogleCloudDataplexV1DataDocumentationResultField
+              ],
+              "name": "A String", # Output only. The name of the column.
+            },
+          ],
+        },
+      },
+    },
+    "dataDocumentationSpec": { # DataDocumentation scan related spec. # Output only. Settings for a data documentation scan.
+    },
     "dataProfileResult": { # DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result. # Output only. The result of a data profile scan.
       "postScanActionsResult": { # The result of post scan actions of DataProfileScan job. # Output only. The result of post scan actions.
         "bigqueryExportResult": { # The result of BigQuery export post scan action. # Output only. The result of BigQuery export post scan action.
diff --git a/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html b/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html
index b7fddbc9ef1..6671b13a375 100644
--- a/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html
+++ b/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html
@@ -229,6 +229,31 @@ 
Method Details

       },
     },
   },
+  "dataDocumentationResult": { # The output of a DataDocumentation scan. # Output only. The result of a data documentation scan.
+    "tableResult": { # Generated metadata about the table. # Output only. Table result for insights.
+      "name": "A String", # Output only. The service-qualified full resource name of the cloud resource. Ex: bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID
+      "overview": "A String", # Output only. Generated description of the table.
+      "queries": [ # Output only. Sample SQL queries for the table.
+        { # A sample SQL query in data documentation.
+          "description": "A String", # Output only. The description for the query.
+          "sql": "A String", # Output only. The SQL query string which can be executed.
+        },
+      ],
+      "schema": { # Schema of the table with generated metadata of columns. # Output only. Schema of the table with generated metadata of the columns in the schema.
+        "fields": [ # Output only. The list of columns.
+          { # Column of a table with generated metadata and nested fields.
+            "description": "A String", # Output only. Generated description for columns and fields.
+            "fields": [ # Output only. Nested fields.
+              # Object with schema name: GoogleCloudDataplexV1DataDocumentationResultField
+            ],
+            "name": "A String", # Output only. The name of the column.
+          },
+        ],
+      },
+    },
+  },
+  "dataDocumentationSpec": { # DataDocumentation scan related spec. # Output only. Settings for a data documentation scan.
+  },
   "dataProfileResult": { # DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result. # Output only. The result of a data profile scan.
     "postScanActionsResult": { # The result of post scan actions of DataProfileScan job. # Output only. The result of post scan actions.
       "bigqueryExportResult": { # The result of BigQuery export post scan action. # Output only. The result of BigQuery export post scan action.
@@ -551,6 +576,31 @@ 
Method Details

           },
         },
       },
+      "dataDocumentationResult": { # The output of a DataDocumentation scan. # Output only. The result of a data documentation scan.
+        "tableResult": { # Generated metadata about the table. # Output only. Table result for insights.
+          "name": "A String", # Output only. The service-qualified full resource name of the cloud resource. Ex: bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID
+          "overview": "A String", # Output only. Generated description of the table.
+          "queries": [ # Output only. Sample SQL queries for the table.
+            { # A sample SQL query in data documentation.
+              "description": "A String", # Output only. The description for the query.
+              "sql": "A String", # Output only. The SQL query string which can be executed.
+            },
+          ],
+          "schema": { # Schema of the table with generated metadata of columns. # Output only. Schema of the table with generated metadata of the columns in the schema.
+            "fields": [ # Output only. The list of columns.
+              { # Column of a table with generated metadata and nested fields.
+                "description": "A String", # Output only. Generated description for columns and fields.
+                "fields": [ # Output only. Nested fields.
+                  # Object with schema name: GoogleCloudDataplexV1DataDocumentationResultField
+                ],
+                "name": "A String", # Output only. The name of the column.
+              },
+            ],
+          },
+        },
+      },
+      "dataDocumentationSpec": { # DataDocumentation scan related spec. # Output only. Settings for a data documentation scan.
+      },
       "dataProfileResult": { # DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result. # Output only. The result of a data profile scan.
         "postScanActionsResult": { # The result of post scan actions of DataProfileScan job. # Output only. The result of post scan actions.
           "bigqueryExportResult": { # The result of BigQuery export post scan action. # Output only. The result of BigQuery export post scan action.
diff --git a/docs/dyn/displayvideo_v2.advertisers.lineItems.html b/docs/dyn/displayvideo_v2.advertisers.lineItems.html
index bbb8dff88b5..023ccfcdad7 100644
--- a/docs/dyn/displayvideo_v2.advertisers.lineItems.html
+++ b/docs/dyn/displayvideo_v2.advertisers.lineItems.html
@@ -823,7 +823,7 @@ 
Method Details

       "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system.
     },
     "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to.
-    "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set when creating a new line item. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned if the parent advertiser has declared that it does not serve EU political ads, or **the `advertisers.lineItems.create` request will fail**.
+    "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.
     "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item.
       "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. This field can't be updated if a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm.
         { # Settings that control the behavior of a single Floodlight activity config.
@@ -936,7 +936,7 @@ 
Method Details

             "vendor": "A String", # The third-party measurement vendor.
           },
         ],
-        "brandSafetyVendorConfigs": [ # The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZERF` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE`
+        "brandSafetyVendorConfigs": [ # The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZEFR` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE`
           { # Settings that control how third-party measurement vendors are configured.
             "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item.
             "vendor": "A String", # The third-party measurement vendor.
@@ -1054,7 +1054,7 @@ 
Method Details

     "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system.
   },
   "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to.
-  "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set when creating a new line item. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned if the parent advertiser has declared that it does not serve EU political ads, or **the `advertisers.lineItems.create` request will fail**.
+  "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.
   "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item.
     "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. This field can't be updated if a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm.
       { # Settings that control the behavior of a single Floodlight activity config.
@@ -1167,7 +1167,7 @@ 
Method Details

           "vendor": "A String", # The third-party measurement vendor.
         },
       ],
-      "brandSafetyVendorConfigs": [ # The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZERF` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE`
+      "brandSafetyVendorConfigs": [ # The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZEFR` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE`
         { # Settings that control how third-party measurement vendors are configured.
           "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item.
           "vendor": "A String", # The third-party measurement vendor.
@@ -1245,7 +1245,7 @@ 
Method Details

     "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system.
   },
   "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to.
-  "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set when creating a new line item. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned if the parent advertiser has declared that it does not serve EU political ads, or **the `advertisers.lineItems.create` request will fail**.
+  "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.
   "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item.
     "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. This field can't be updated if a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm.
       { # Settings that control the behavior of a single Floodlight activity config.
@@ -1358,7 +1358,7 @@ 
Method Details

           "vendor": "A String", # The third-party measurement vendor.
         },
       ],
-      "brandSafetyVendorConfigs": [ # The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZERF` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE`
+      "brandSafetyVendorConfigs": [ # The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZEFR` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE`
         { # Settings that control how third-party measurement vendors are configured.
           "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item.
           "vendor": "A String", # The third-party measurement vendor.
@@ -1434,7 +1434,7 @@ 
Method Details

     The object takes the form of:
 
 { # Request message for LineItemService.DuplicateLineItem.
-  "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned to the line item if the parent advertiser has declared that it does not serve EU political ads, or **the request will fail**.
+  "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.
   "targetDisplayName": "A String", # The display name of the new line item. Must be UTF-8 encoded with a maximum size of 240 bytes.
 }
 
@@ -1461,7 +1461,7 @@ 
Method Details

     The object takes the form of:
 
 { # Request message for LineItemService.GenerateDefaultLineItem.
-  "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned to the line item if the parent advertiser has declared that it does not serve EU political ads, or **the request will fail**.
+  "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.
   "displayName": "A String", # Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes.
   "insertionOrderId": "A String", # Required. The unique ID of the insertion order that the line item belongs to.
   "lineItemType": "A String", # Required. The type of the line item.
@@ -1506,7 +1506,7 @@ 
Method Details

     "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system.
   },
   "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to.
-  "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set when creating a new line item. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned if the parent advertiser has declared that it does not serve EU political ads, or **the `advertisers.lineItems.create` request will fail**.
+  "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.
   "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item.
     "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. This field can't be updated if a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm.
       { # Settings that control the behavior of a single Floodlight activity config.
@@ -1619,7 +1619,7 @@ 
Method Details

           "vendor": "A String", # The third-party measurement vendor.
         },
       ],
-      "brandSafetyVendorConfigs": [ # The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZERF` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE`
+      "brandSafetyVendorConfigs": [ # The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZEFR` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE`
         { # Settings that control how third-party measurement vendors are configured.
           "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item.
           "vendor": "A String", # The third-party measurement vendor.
@@ -1705,7 +1705,7 @@ 
Method Details

     "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system.
   },
   "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to.
-  "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set when creating a new line item. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned if the parent advertiser has declared that it does not serve EU political ads, or **the `advertisers.lineItems.create` request will fail**.
+  "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.
   "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item.
     "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. This field can't be updated if a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm.
       { # Settings that control the behavior of a single Floodlight activity config.
@@ -1818,7 +1818,7 @@ 
Method Details

           "vendor": "A String", # The third-party measurement vendor.
         },
       ],
-      "brandSafetyVendorConfigs": [ # The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZERF` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE`
+      "brandSafetyVendorConfigs": [ # The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZEFR` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE`
         { # Settings that control how third-party measurement vendors are configured.
           "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item.
           "vendor": "A String", # The third-party measurement vendor.
@@ -1909,7 +1909,7 @@ 
Method Details

         "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system.
       },
       "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to.
-      "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set when creating a new line item. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned if the parent advertiser has declared that it does not serve EU political ads, or **the `advertisers.lineItems.create` request will fail**.
+      "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.
       "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item.
         "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. This field can't be updated if a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm.
           { # Settings that control the behavior of a single Floodlight activity config.
@@ -2022,7 +2022,7 @@ 
Method Details

               "vendor": "A String", # The third-party measurement vendor.
             },
           ],
-          "brandSafetyVendorConfigs": [ # The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZERF` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE`
+          "brandSafetyVendorConfigs": [ # The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZEFR` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE`
             { # Settings that control how third-party measurement vendors are configured.
               "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item.
               "vendor": "A String", # The third-party measurement vendor.
@@ -2120,7 +2120,7 @@ 
Method Details

     "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system.
   },
   "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to.
-  "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set when creating a new line item. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned if the parent advertiser has declared that it does not serve EU political ads, or **the `advertisers.lineItems.create` request will fail**.
+  "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.
   "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item.
     "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. This field can't be updated if a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm.
       { # Settings that control the behavior of a single Floodlight activity config.
@@ -2233,7 +2233,7 @@ 
Method Details

           "vendor": "A String", # The third-party measurement vendor.
         },
       ],
-      "brandSafetyVendorConfigs": [ # The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZERF` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE`
+      "brandSafetyVendorConfigs": [ # The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZEFR` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE`
         { # Settings that control how third-party measurement vendors are configured.
           "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item.
           "vendor": "A String", # The third-party measurement vendor.
@@ -2312,7 +2312,7 @@ 
Method Details

     "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system.
   },
   "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to.
-  "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set when creating a new line item. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned if the parent advertiser has declared that it does not serve EU political ads, or **the `advertisers.lineItems.create` request will fail**.
+  "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.
   "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item.
     "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. This field can't be updated if a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm.
       { # Settings that control the behavior of a single Floodlight activity config.
@@ -2425,7 +2425,7 @@ 
Method Details

           "vendor": "A String", # The third-party measurement vendor.
         },
       ],
-      "brandSafetyVendorConfigs": [ # The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZERF` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE`
+      "brandSafetyVendorConfigs": [ # The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZEFR` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE`
         { # Settings that control how third-party measurement vendors are configured.
           "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item.
           "vendor": "A String", # The third-party measurement vendor.
diff --git a/docs/dyn/displayvideo_v3.advertisers.lineItems.html b/docs/dyn/displayvideo_v3.advertisers.lineItems.html
index 180141b675d..bbafb86b572 100644
--- a/docs/dyn/displayvideo_v3.advertisers.lineItems.html
+++ b/docs/dyn/displayvideo_v3.advertisers.lineItems.html
@@ -915,7 +915,7 @@ 
Method Details

       "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system.
     },
     "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to.
-    "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set when creating a new line item. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned if the parent advertiser has declared that it does not serve EU political ads, or **the `advertisers.lineItems.create` request will fail**.
+    "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.
     "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item.
       "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. This field can't be updated if a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm.
         { # Settings that control the behavior of a single Floodlight activity config.
@@ -1146,7 +1146,7 @@ 
Method Details

     "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system.
   },
   "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to.
-  "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set when creating a new line item. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned if the parent advertiser has declared that it does not serve EU political ads, or **the `advertisers.lineItems.create` request will fail**.
+  "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.
   "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item.
     "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. This field can't be updated if a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm.
       { # Settings that control the behavior of a single Floodlight activity config.
@@ -1337,7 +1337,7 @@ 
Method Details

     "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system.
   },
   "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to.
-  "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set when creating a new line item. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned if the parent advertiser has declared that it does not serve EU political ads, or **the `advertisers.lineItems.create` request will fail**.
+  "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.
   "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item.
     "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. This field can't be updated if a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm.
       { # Settings that control the behavior of a single Floodlight activity config.
@@ -1520,7 +1520,7 @@ 
Method Details

     The object takes the form of:
 
 { # Request message for LineItemService.DuplicateLineItem.
-  "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned to the line item if the parent advertiser has declared that it does not serve EU political ads, or **the request will fail**.
+  "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.
   "targetDisplayName": "A String", # The display name of the new line item. Must be UTF-8 encoded with a maximum size of 240 bytes.
 }
 
@@ -1547,7 +1547,7 @@ 
Method Details

     The object takes the form of:
 
 { # Request message for LineItemService.GenerateDefaultLineItem.
-  "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned to the line item if the parent advertiser has declared that it does not serve EU political ads, or **the request will fail**.
+  "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.
   "displayName": "A String", # Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes.
   "insertionOrderId": "A String", # Required. The unique ID of the insertion order that the line item belongs to.
   "lineItemType": "A String", # Required. The type of the line item.
@@ -1598,7 +1598,7 @@ 
Method Details

     "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system.
   },
   "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to.
-  "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set when creating a new line item. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned if the parent advertiser has declared that it does not serve EU political ads, or **the `advertisers.lineItems.create` request will fail**.
+  "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.
   "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item.
     "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. This field can't be updated if a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm.
       { # Settings that control the behavior of a single Floodlight activity config.
@@ -1797,7 +1797,7 @@ 
Method Details

     "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system.
   },
   "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to.
-  "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set when creating a new line item. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned if the parent advertiser has declared that it does not serve EU political ads, or **the `advertisers.lineItems.create` request will fail**.
+  "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.
   "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item.
     "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. This field can't be updated if a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm.
       { # Settings that control the behavior of a single Floodlight activity config.
@@ -2001,7 +2001,7 @@ 
Method Details

         "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system.
       },
       "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to.
-      "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set when creating a new line item. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned if the parent advertiser has declared that it does not serve EU political ads, or **the `advertisers.lineItems.create` request will fail**.
+      "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.
       "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item.
         "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. This field can't be updated if a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm.
           { # Settings that control the behavior of a single Floodlight activity config.
@@ -2212,7 +2212,7 @@ 
Method Details

     "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system.
   },
   "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to.
-  "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set when creating a new line item. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned if the parent advertiser has declared that it does not serve EU political ads, or **the `advertisers.lineItems.create` request will fail**.
+  "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.
   "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item.
     "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. This field can't be updated if a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm.
       { # Settings that control the behavior of a single Floodlight activity config.
@@ -2404,7 +2404,7 @@ 
Method Details

     "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system.
   },
   "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to.
-  "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set when creating a new line item. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned if the parent advertiser has declared that it does not serve EU political ads, or **the `advertisers.lineItems.create` request will fail**.
+  "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.
   "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item.
     "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. This field can't be updated if a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm.
       { # Settings that control the behavior of a single Floodlight activity config.
diff --git a/docs/dyn/displayvideo_v4.advertisers.lineItems.html b/docs/dyn/displayvideo_v4.advertisers.lineItems.html
index d92a37374a6..853ff6fd247 100644
--- a/docs/dyn/displayvideo_v4.advertisers.lineItems.html
+++ b/docs/dyn/displayvideo_v4.advertisers.lineItems.html
@@ -915,7 +915,7 @@ 
Method Details

       "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system.
     },
     "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to.
-    "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set when creating a new line item. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned if the parent advertiser has declared that it does not serve EU political ads, or **the `advertisers.lineItems.create` request will fail**.
+    "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.
     "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item.
       "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. This field can't be updated if a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm.
         { # Settings that control the behavior of a single Floodlight activity config.
@@ -1146,7 +1146,7 @@ 
Method Details

     "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system.
   },
   "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to.
-  "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set when creating a new line item. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned if the parent advertiser has declared that it does not serve EU political ads, or **the `advertisers.lineItems.create` request will fail**.
+  "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.
   "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item.
     "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. This field can't be updated if a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm.
       { # Settings that control the behavior of a single Floodlight activity config.
@@ -1337,7 +1337,7 @@ 
Method Details

     "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system.
   },
   "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to.
-  "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set when creating a new line item. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned if the parent advertiser has declared that it does not serve EU political ads, or **the `advertisers.lineItems.create` request will fail**.
+  "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.
   "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item.
     "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. This field can't be updated if a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm.
       { # Settings that control the behavior of a single Floodlight activity config.
@@ -1520,7 +1520,7 @@ 
Method Details

     The object takes the form of:
 
 { # Request message for LineItemService.DuplicateLineItem.
-  "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned to the line item if the parent advertiser has declared that it does not serve EU political ads, or **the request will fail**.
+  "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.
   "targetDisplayName": "A String", # The display name of the new line item. Must be UTF-8 encoded with a maximum size of 240 bytes.
 }
 
@@ -1547,7 +1547,7 @@ 
Method Details

     The object takes the form of:
 
 { # Request message for LineItemService.GenerateDefaultLineItem.
-  "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned to the line item if the parent advertiser has declared that it does not serve EU political ads, or **the request will fail**.
+  "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.
   "displayName": "A String", # Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes.
   "insertionOrderId": "A String", # Required. The unique ID of the insertion order that the line item belongs to.
   "lineItemType": "A String", # Required. The type of the line item.
@@ -1598,7 +1598,7 @@ 
Method Details

     "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system.
   },
   "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to.
-  "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set when creating a new line item. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned if the parent advertiser has declared that it does not serve EU political ads, or **the `advertisers.lineItems.create` request will fail**.
+  "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.
   "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item.
     "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. This field can't be updated if a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm.
       { # Settings that control the behavior of a single Floodlight activity config.
@@ -1797,7 +1797,7 @@ 
Method Details

     "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system.
   },
   "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to.
-  "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set when creating a new line item. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned if the parent advertiser has declared that it does not serve EU political ads, or **the `advertisers.lineItems.create` request will fail**.
+  "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.
   "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item.
     "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. This field can't be updated if a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm.
       { # Settings that control the behavior of a single Floodlight activity config.
@@ -2001,7 +2001,7 @@ 
Method Details

         "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system.
       },
       "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to.
-      "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set when creating a new line item. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned if the parent advertiser has declared that it does not serve EU political ads, or **the `advertisers.lineItems.create` request will fail**.
+      "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.
       "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item.
         "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. This field can't be updated if a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm.
           { # Settings that control the behavior of a single Floodlight activity config.
@@ -2212,7 +2212,7 @@ 
Method Details

     "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system.
   },
   "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to.
-  "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set when creating a new line item. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned if the parent advertiser has declared that it does not serve EU political ads, or **the `advertisers.lineItems.create` request will fail**.
+  "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.
   "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item.
     "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. This field can't be updated if a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm.
       { # Settings that control the behavior of a single Floodlight activity config.
@@ -2404,7 +2404,7 @@ 
Method Details

     "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system.
   },
   "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to.
-  "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set when creating a new line item. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned if the parent advertiser has declared that it does not serve EU political ads, or **the `advertisers.lineItems.create` request will fail**.
+  "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.
   "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item.
     "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. This field can't be updated if a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm.
       { # Settings that control the behavior of a single Floodlight activity config.
diff --git a/docs/dyn/gkebackup_v1.projects.locations.backupPlans.html b/docs/dyn/gkebackup_v1.projects.locations.backupPlans.html
index 0a2d17b3439..2e8bce7a0ac 100644
--- a/docs/dyn/gkebackup_v1.projects.locations.backupPlans.html
+++ b/docs/dyn/gkebackup_v1.projects.locations.backupPlans.html
@@ -175,7 +175,7 @@ 
Method Details

             "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.
           },
-          "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`. # Required. Specifies the start time of the window using time of the day in UTC.
+          "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`. # Optional. Specifies the start time of the window using time of the day in UTC.
             "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.
@@ -341,7 +341,7 @@ 
Method Details

             "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.
           },
-          "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`. # Required. Specifies the start time of the window using time of the day in UTC.
+          "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`. # Optional. Specifies the start time of the window using time of the day in UTC.
             "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.
@@ -496,7 +496,7 @@ 
Method Details

                 "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.
               },
-              "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`. # Required. Specifies the start time of the window using time of the day in UTC.
+              "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`. # Optional. Specifies the start time of the window using time of the day in UTC.
                 "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.
@@ -612,7 +612,7 @@ 
Method Details

             "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.
           },
-          "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`. # Required. Specifies the start time of the window using time of the day in UTC.
+          "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`. # Optional. Specifies the start time of the window using time of the day in UTC.
             "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.
diff --git a/docs/dyn/gkebackup_v1.projects.locations.html b/docs/dyn/gkebackup_v1.projects.locations.html
index f6b26da5cc8..2f9b8a75c1f 100644
--- a/docs/dyn/gkebackup_v1.projects.locations.html
+++ b/docs/dyn/gkebackup_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. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (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/iam_v1.locations.workforcePools.html b/docs/dyn/iam_v1.locations.workforcePools.html
index 6c912ac74b8..0f35e4ca5ee 100644
--- a/docs/dyn/iam_v1.locations.workforcePools.html
+++ b/docs/dyn/iam_v1.locations.workforcePools.html
@@ -146,9 +146,9 @@ 
Method Details

     ],
     "disableProgrammaticSignin": True or False, # Optional. Disable programmatic sign-in by disabling token issue via the Security Token API endpoint. See [Security Token Service API] (https://cloud.google.com/iam/docs/reference/sts/rest).
   },
-  "description": "A String", # Optional. A user-specified description of the pool. Cannot exceed 256 characters.
+  "description": "A String", # Optional. A description of the pool. Cannot exceed 256 characters.
   "disabled": True or False, # Optional. Disables the workforce pool. You cannot use a disabled pool to exchange tokens, or use existing tokens to access resources. If the pool is re-enabled, existing tokens grant access again.
-  "displayName": "A String", # Optional. A user-specified display name of the pool in Google Cloud Console. Cannot exceed 32 characters.
+  "displayName": "A String", # Optional. A display name for the pool. Cannot exceed 32 characters.
   "expireTime": "A String", # Output only. Time after which the workforce pool will be permanently purged and cannot be recovered.
   "name": "A String", # Identifier. The resource name of the pool. Format: `locations/{location}/workforcePools/{workforce_pool_id}`
   "parent": "A String", # Immutable. The resource name of the parent. Format: `organizations/{org-id}`.
@@ -244,9 +244,9 @@ 
Method Details

     ],
     "disableProgrammaticSignin": True or False, # Optional. Disable programmatic sign-in by disabling token issue via the Security Token API endpoint. See [Security Token Service API] (https://cloud.google.com/iam/docs/reference/sts/rest).
   },
-  "description": "A String", # Optional. A user-specified description of the pool. Cannot exceed 256 characters.
+  "description": "A String", # Optional. A description of the pool. Cannot exceed 256 characters.
   "disabled": True or False, # Optional. Disables the workforce pool. You cannot use a disabled pool to exchange tokens, or use existing tokens to access resources. If the pool is re-enabled, existing tokens grant access again.
-  "displayName": "A String", # Optional. A user-specified display name of the pool in Google Cloud Console. Cannot exceed 32 characters.
+  "displayName": "A String", # Optional. A display name for the pool. Cannot exceed 32 characters.
   "expireTime": "A String", # Output only. Time after which the workforce pool will be permanently purged and cannot be recovered.
   "name": "A String", # Identifier. The resource name of the pool. Format: `locations/{location}/workforcePools/{workforce_pool_id}`
   "parent": "A String", # Immutable. The resource name of the parent. Format: `organizations/{org-id}`.
@@ -341,9 +341,9 @@ 
Method Details

         ],
         "disableProgrammaticSignin": True or False, # Optional. Disable programmatic sign-in by disabling token issue via the Security Token API endpoint. See [Security Token Service API] (https://cloud.google.com/iam/docs/reference/sts/rest).
       },
-      "description": "A String", # Optional. A user-specified description of the pool. Cannot exceed 256 characters.
+      "description": "A String", # Optional. A description of the pool. Cannot exceed 256 characters.
       "disabled": True or False, # Optional. Disables the workforce pool. You cannot use a disabled pool to exchange tokens, or use existing tokens to access resources. If the pool is re-enabled, existing tokens grant access again.
-      "displayName": "A String", # Optional. A user-specified display name of the pool in Google Cloud Console. Cannot exceed 32 characters.
+      "displayName": "A String", # Optional. A display name for the pool. Cannot exceed 32 characters.
       "expireTime": "A String", # Output only. Time after which the workforce pool will be permanently purged and cannot be recovered.
       "name": "A String", # Identifier. The resource name of the pool. Format: `locations/{location}/workforcePools/{workforce_pool_id}`
       "parent": "A String", # Immutable. The resource name of the parent. Format: `organizations/{org-id}`.
@@ -386,9 +386,9 @@ 
Method Details

     ],
     "disableProgrammaticSignin": True or False, # Optional. Disable programmatic sign-in by disabling token issue via the Security Token API endpoint. See [Security Token Service API] (https://cloud.google.com/iam/docs/reference/sts/rest).
   },
-  "description": "A String", # Optional. A user-specified description of the pool. Cannot exceed 256 characters.
+  "description": "A String", # Optional. A description of the pool. Cannot exceed 256 characters.
   "disabled": True or False, # Optional. Disables the workforce pool. You cannot use a disabled pool to exchange tokens, or use existing tokens to access resources. If the pool is re-enabled, existing tokens grant access again.
-  "displayName": "A String", # Optional. A user-specified display name of the pool in Google Cloud Console. Cannot exceed 32 characters.
+  "displayName": "A String", # Optional. A display name for the pool. Cannot exceed 32 characters.
   "expireTime": "A String", # Output only. Time after which the workforce pool will be permanently purged and cannot be recovered.
   "name": "A String", # Identifier. The resource name of the pool. Format: `locations/{location}/workforcePools/{workforce_pool_id}`
   "parent": "A String", # Immutable. The resource name of the parent. Format: `organizations/{org-id}`.
diff --git a/docs/dyn/iam_v1.locations.workforcePools.providers.html b/docs/dyn/iam_v1.locations.workforcePools.providers.html
index dc4808d9291..a3ce0900f4b 100644
--- a/docs/dyn/iam_v1.locations.workforcePools.providers.html
+++ b/docs/dyn/iam_v1.locations.workforcePools.providers.html
@@ -133,10 +133,10 @@ 
Method Details

   "attributeMapping": { # Required. Maps attributes from the authentication credentials issued by an external identity provider to Google Cloud attributes, such as `subject` and `segment`. Each key must be a string specifying the Google Cloud IAM attribute to map to. The following keys are supported: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. This is a required field and the mapped subject cannot exceed 127 bytes. * `google.groups`: Groups the authenticating user belongs to. You can grant groups access to resources using an IAM `principalSet` binding; access applies to all members of the group. * `google.display_name`: The name of the authenticated user. This is an optional field and the mapped display name cannot exceed 100 bytes. If not set, `google.subject` will be displayed instead. This attribute cannot be referenced in IAM bindings. * `google.profile_photo`: The URL that specifies the authenticated user's thumbnail photo. This is an optional field. When set, the image will be visible as the user's profile picture. If not set, a generic user icon will be displayed instead. This attribute cannot be referenced in IAM bindings. * `google.posix_username`: The Linux username used by OS Login. This is an optional field and the mapped POSIX username cannot exceed 32 characters, The key must match the regex "^a-zA-Z0-9._{0,31}$". This attribute cannot be referenced in IAM bindings. You can also provide custom attributes by specifying `attribute.{custom_attribute}`, where {custom_attribute} is the name of the custom attribute to be mapped. You can define a maximum of 50 custom attributes. The maximum length of a mapped attribute key is 100 characters, and the key may only contain the characters [a-z0-9_]. You can reference these attributes in IAM policies to define fine-grained access for a workforce pool to Google Cloud resources. For example: * `google.subject`: `principal://iam.googleapis.com/locations/global/workforcePools/{pool}/subject/{value}` * `google.groups`: `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/group/{value}` * `attribute.{custom_attribute}`: `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/attribute.{custom_attribute}/{value}` Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) function that maps an identity provider credential to the normalized attribute specified by the corresponding map key. You can use the `assertion` keyword in the expression to access a JSON representation of the authentication credential issued by the provider. The maximum length of an attribute mapping expression is 2048 characters. When evaluated, the total size of all mapped attributes must not exceed 4KB. For OIDC providers, you must supply a custom mapping that includes the `google.subject` attribute. For example, the following maps the `sub` claim of the incoming credential to the `subject` attribute on a Google token: ``` {"google.subject": "assertion.sub"} ```
     "a_key": "A String",
   },
-  "description": "A String", # Optional. A user-specified description of the provider. Cannot exceed 256 characters.
+  "description": "A String", # Optional. A description of the provider. Cannot exceed 256 characters.
   "detailedAuditLogging": True or False, # Optional. If true, populates additional debug information in Cloud Audit Logs for this provider. Logged attribute mappings and values can be found in `sts.googleapis.com` data access logs. Default value is false.
   "disabled": True or False, # Optional. Disables the workforce pool provider. You cannot use a disabled provider to exchange tokens. However, existing tokens still grant access.
-  "displayName": "A String", # Optional. A user-specified display name for the provider. Cannot exceed 32 characters.
+  "displayName": "A String", # Optional. A display name for the provider. Cannot exceed 32 characters.
   "expireTime": "A String", # Output only. Time after which the workforce identity pool provider will be permanently purged and cannot be recovered.
   "extendedAttributesOauth2Client": { # Represents the OAuth 2.0 client credential configuration for retrieving additional user attributes that are not present in the initial authentication credentials from the identity provider, e.g. groups. See https://datatracker.ietf.org/doc/html/rfc6749#section-4.4 for more details on client credentials grant flow. # Optional. The configuration for OAuth 2.0 client used to get the extended group memberships for user identities. Only the `AZURE_AD_GROUPS_ID` attribute type is supported. Extended groups supports a subset of Google Cloud services. When the user accesses these services, extended group memberships override the mapped `google.groups` attribute. Extended group memberships cannot be used in attribute mapping or attribute condition expressions. To keep extended group memberships up to date, extended groups are retrieved when the user signs in and at regular intervals during the user's active session. Each user identity in the workforce identity pool must map to a unique Microsoft Entra ID user.
     "attributesType": "A String", # Required. Represents the IdP and type of claims that should be fetched.
@@ -275,10 +275,10 @@ 
Method Details

   "attributeMapping": { # Required. Maps attributes from the authentication credentials issued by an external identity provider to Google Cloud attributes, such as `subject` and `segment`. Each key must be a string specifying the Google Cloud IAM attribute to map to. The following keys are supported: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. This is a required field and the mapped subject cannot exceed 127 bytes. * `google.groups`: Groups the authenticating user belongs to. You can grant groups access to resources using an IAM `principalSet` binding; access applies to all members of the group. * `google.display_name`: The name of the authenticated user. This is an optional field and the mapped display name cannot exceed 100 bytes. If not set, `google.subject` will be displayed instead. This attribute cannot be referenced in IAM bindings. * `google.profile_photo`: The URL that specifies the authenticated user's thumbnail photo. This is an optional field. When set, the image will be visible as the user's profile picture. If not set, a generic user icon will be displayed instead. This attribute cannot be referenced in IAM bindings. * `google.posix_username`: The Linux username used by OS Login. This is an optional field and the mapped POSIX username cannot exceed 32 characters, The key must match the regex "^a-zA-Z0-9._{0,31}$". This attribute cannot be referenced in IAM bindings. You can also provide custom attributes by specifying `attribute.{custom_attribute}`, where {custom_attribute} is the name of the custom attribute to be mapped. You can define a maximum of 50 custom attributes. The maximum length of a mapped attribute key is 100 characters, and the key may only contain the characters [a-z0-9_]. You can reference these attributes in IAM policies to define fine-grained access for a workforce pool to Google Cloud resources. For example: * `google.subject`: `principal://iam.googleapis.com/locations/global/workforcePools/{pool}/subject/{value}` * `google.groups`: `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/group/{value}` * `attribute.{custom_attribute}`: `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/attribute.{custom_attribute}/{value}` Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) function that maps an identity provider credential to the normalized attribute specified by the corresponding map key. You can use the `assertion` keyword in the expression to access a JSON representation of the authentication credential issued by the provider. The maximum length of an attribute mapping expression is 2048 characters. When evaluated, the total size of all mapped attributes must not exceed 4KB. For OIDC providers, you must supply a custom mapping that includes the `google.subject` attribute. For example, the following maps the `sub` claim of the incoming credential to the `subject` attribute on a Google token: ``` {"google.subject": "assertion.sub"} ```
     "a_key": "A String",
   },
-  "description": "A String", # Optional. A user-specified description of the provider. Cannot exceed 256 characters.
+  "description": "A String", # Optional. A description of the provider. Cannot exceed 256 characters.
   "detailedAuditLogging": True or False, # Optional. If true, populates additional debug information in Cloud Audit Logs for this provider. Logged attribute mappings and values can be found in `sts.googleapis.com` data access logs. Default value is false.
   "disabled": True or False, # Optional. Disables the workforce pool provider. You cannot use a disabled provider to exchange tokens. However, existing tokens still grant access.
-  "displayName": "A String", # Optional. A user-specified display name for the provider. Cannot exceed 32 characters.
+  "displayName": "A String", # Optional. A display name for the provider. Cannot exceed 32 characters.
   "expireTime": "A String", # Output only. Time after which the workforce identity pool provider will be permanently purged and cannot be recovered.
   "extendedAttributesOauth2Client": { # Represents the OAuth 2.0 client credential configuration for retrieving additional user attributes that are not present in the initial authentication credentials from the identity provider, e.g. groups. See https://datatracker.ietf.org/doc/html/rfc6749#section-4.4 for more details on client credentials grant flow. # Optional. The configuration for OAuth 2.0 client used to get the extended group memberships for user identities. Only the `AZURE_AD_GROUPS_ID` attribute type is supported. Extended groups supports a subset of Google Cloud services. When the user accesses these services, extended group memberships override the mapped `google.groups` attribute. Extended group memberships cannot be used in attribute mapping or attribute condition expressions. To keep extended group memberships up to date, extended groups are retrieved when the user signs in and at regular intervals during the user's active session. Each user identity in the workforce identity pool must map to a unique Microsoft Entra ID user.
     "attributesType": "A String", # Required. Represents the IdP and type of claims that should be fetched.
@@ -359,10 +359,10 @@ 
Method Details

       "attributeMapping": { # Required. Maps attributes from the authentication credentials issued by an external identity provider to Google Cloud attributes, such as `subject` and `segment`. Each key must be a string specifying the Google Cloud IAM attribute to map to. The following keys are supported: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. This is a required field and the mapped subject cannot exceed 127 bytes. * `google.groups`: Groups the authenticating user belongs to. You can grant groups access to resources using an IAM `principalSet` binding; access applies to all members of the group. * `google.display_name`: The name of the authenticated user. This is an optional field and the mapped display name cannot exceed 100 bytes. If not set, `google.subject` will be displayed instead. This attribute cannot be referenced in IAM bindings. * `google.profile_photo`: The URL that specifies the authenticated user's thumbnail photo. This is an optional field. When set, the image will be visible as the user's profile picture. If not set, a generic user icon will be displayed instead. This attribute cannot be referenced in IAM bindings. * `google.posix_username`: The Linux username used by OS Login. This is an optional field and the mapped POSIX username cannot exceed 32 characters, The key must match the regex "^a-zA-Z0-9._{0,31}$". This attribute cannot be referenced in IAM bindings. You can also provide custom attributes by specifying `attribute.{custom_attribute}`, where {custom_attribute} is the name of the custom attribute to be mapped. You can define a maximum of 50 custom attributes. The maximum length of a mapped attribute key is 100 characters, and the key may only contain the characters [a-z0-9_]. You can reference these attributes in IAM policies to define fine-grained access for a workforce pool to Google Cloud resources. For example: * `google.subject`: `principal://iam.googleapis.com/locations/global/workforcePools/{pool}/subject/{value}` * `google.groups`: `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/group/{value}` * `attribute.{custom_attribute}`: `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/attribute.{custom_attribute}/{value}` Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) function that maps an identity provider credential to the normalized attribute specified by the corresponding map key. You can use the `assertion` keyword in the expression to access a JSON representation of the authentication credential issued by the provider. The maximum length of an attribute mapping expression is 2048 characters. When evaluated, the total size of all mapped attributes must not exceed 4KB. For OIDC providers, you must supply a custom mapping that includes the `google.subject` attribute. For example, the following maps the `sub` claim of the incoming credential to the `subject` attribute on a Google token: ``` {"google.subject": "assertion.sub"} ```
         "a_key": "A String",
       },
-      "description": "A String", # Optional. A user-specified description of the provider. Cannot exceed 256 characters.
+      "description": "A String", # Optional. A description of the provider. Cannot exceed 256 characters.
       "detailedAuditLogging": True or False, # Optional. If true, populates additional debug information in Cloud Audit Logs for this provider. Logged attribute mappings and values can be found in `sts.googleapis.com` data access logs. Default value is false.
       "disabled": True or False, # Optional. Disables the workforce pool provider. You cannot use a disabled provider to exchange tokens. However, existing tokens still grant access.
-      "displayName": "A String", # Optional. A user-specified display name for the provider. Cannot exceed 32 characters.
+      "displayName": "A String", # Optional. A display name for the provider. Cannot exceed 32 characters.
       "expireTime": "A String", # Output only. Time after which the workforce identity pool provider will be permanently purged and cannot be recovered.
       "extendedAttributesOauth2Client": { # Represents the OAuth 2.0 client credential configuration for retrieving additional user attributes that are not present in the initial authentication credentials from the identity provider, e.g. groups. See https://datatracker.ietf.org/doc/html/rfc6749#section-4.4 for more details on client credentials grant flow. # Optional. The configuration for OAuth 2.0 client used to get the extended group memberships for user identities. Only the `AZURE_AD_GROUPS_ID` attribute type is supported. Extended groups supports a subset of Google Cloud services. When the user accesses these services, extended group memberships override the mapped `google.groups` attribute. Extended group memberships cannot be used in attribute mapping or attribute condition expressions. To keep extended group memberships up to date, extended groups are retrieved when the user signs in and at regular intervals during the user's active session. Each user identity in the workforce identity pool must map to a unique Microsoft Entra ID user.
         "attributesType": "A String", # Required. Represents the IdP and type of claims that should be fetched.
@@ -448,10 +448,10 @@ 
Method Details

   "attributeMapping": { # Required. Maps attributes from the authentication credentials issued by an external identity provider to Google Cloud attributes, such as `subject` and `segment`. Each key must be a string specifying the Google Cloud IAM attribute to map to. The following keys are supported: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. This is a required field and the mapped subject cannot exceed 127 bytes. * `google.groups`: Groups the authenticating user belongs to. You can grant groups access to resources using an IAM `principalSet` binding; access applies to all members of the group. * `google.display_name`: The name of the authenticated user. This is an optional field and the mapped display name cannot exceed 100 bytes. If not set, `google.subject` will be displayed instead. This attribute cannot be referenced in IAM bindings. * `google.profile_photo`: The URL that specifies the authenticated user's thumbnail photo. This is an optional field. When set, the image will be visible as the user's profile picture. If not set, a generic user icon will be displayed instead. This attribute cannot be referenced in IAM bindings. * `google.posix_username`: The Linux username used by OS Login. This is an optional field and the mapped POSIX username cannot exceed 32 characters, The key must match the regex "^a-zA-Z0-9._{0,31}$". This attribute cannot be referenced in IAM bindings. You can also provide custom attributes by specifying `attribute.{custom_attribute}`, where {custom_attribute} is the name of the custom attribute to be mapped. You can define a maximum of 50 custom attributes. The maximum length of a mapped attribute key is 100 characters, and the key may only contain the characters [a-z0-9_]. You can reference these attributes in IAM policies to define fine-grained access for a workforce pool to Google Cloud resources. For example: * `google.subject`: `principal://iam.googleapis.com/locations/global/workforcePools/{pool}/subject/{value}` * `google.groups`: `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/group/{value}` * `attribute.{custom_attribute}`: `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/attribute.{custom_attribute}/{value}` Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) function that maps an identity provider credential to the normalized attribute specified by the corresponding map key. You can use the `assertion` keyword in the expression to access a JSON representation of the authentication credential issued by the provider. The maximum length of an attribute mapping expression is 2048 characters. When evaluated, the total size of all mapped attributes must not exceed 4KB. For OIDC providers, you must supply a custom mapping that includes the `google.subject` attribute. For example, the following maps the `sub` claim of the incoming credential to the `subject` attribute on a Google token: ``` {"google.subject": "assertion.sub"} ```
     "a_key": "A String",
   },
-  "description": "A String", # Optional. A user-specified description of the provider. Cannot exceed 256 characters.
+  "description": "A String", # Optional. A description of the provider. Cannot exceed 256 characters.
   "detailedAuditLogging": True or False, # Optional. If true, populates additional debug information in Cloud Audit Logs for this provider. Logged attribute mappings and values can be found in `sts.googleapis.com` data access logs. Default value is false.
   "disabled": True or False, # Optional. Disables the workforce pool provider. You cannot use a disabled provider to exchange tokens. However, existing tokens still grant access.
-  "displayName": "A String", # Optional. A user-specified display name for the provider. Cannot exceed 32 characters.
+  "displayName": "A String", # Optional. A display name for the provider. Cannot exceed 32 characters.
   "expireTime": "A String", # Output only. Time after which the workforce identity pool provider will be permanently purged and cannot be recovered.
   "extendedAttributesOauth2Client": { # Represents the OAuth 2.0 client credential configuration for retrieving additional user attributes that are not present in the initial authentication credentials from the identity provider, e.g. groups. See https://datatracker.ietf.org/doc/html/rfc6749#section-4.4 for more details on client credentials grant flow. # Optional. The configuration for OAuth 2.0 client used to get the extended group memberships for user identities. Only the `AZURE_AD_GROUPS_ID` attribute type is supported. Extended groups supports a subset of Google Cloud services. When the user accesses these services, extended group memberships override the mapped `google.groups` attribute. Extended group memberships cannot be used in attribute mapping or attribute condition expressions. To keep extended group memberships up to date, extended groups are retrieved when the user signs in and at regular intervals during the user's active session. Each user identity in the workforce identity pool must map to a unique Microsoft Entra ID user.
     "attributesType": "A String", # Required. Represents the IdP and type of claims that should be fetched.
diff --git a/docs/dyn/iam_v1.locations.workforcePools.providers.scimTenants.html b/docs/dyn/iam_v1.locations.workforcePools.providers.scimTenants.html
index 39c34bb96e5..f9559903e45 100644
--- a/docs/dyn/iam_v1.locations.workforcePools.providers.scimTenants.html
+++ b/docs/dyn/iam_v1.locations.workforcePools.providers.scimTenants.html
@@ -123,8 +123,8 @@ 
Method Details

   "claimMapping": { # Optional. Maps BYOID claims to SCIM claims.
     "a_key": "A String",
   },
-  "description": "A String", # Optional. The user-specified description of the scim tenant. Cannot exceed 256 characters.
-  "displayName": "A String", # Optional. The user-specified display name of the scim tenant. Cannot exceed 32 characters.
+  "description": "A String", # Optional. The description of the scim tenant. Cannot exceed 256 characters.
+  "displayName": "A String", # Optional. The display name of the scim tenant. Cannot exceed 32 characters.
   "name": "A String", # Identifier. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}`
   "purgeTime": "A String", # Output only. The timestamp when the scim tenant is going to be purged.
   "state": "A String", # Output only. The state of the tenant.
@@ -144,8 +144,8 @@ 
Method Details

   "claimMapping": { # Optional. Maps BYOID claims to SCIM claims.
     "a_key": "A String",
   },
-  "description": "A String", # Optional. The user-specified description of the scim tenant. Cannot exceed 256 characters.
-  "displayName": "A String", # Optional. The user-specified display name of the scim tenant. Cannot exceed 32 characters.
+  "description": "A String", # Optional. The description of the scim tenant. Cannot exceed 256 characters.
+  "displayName": "A String", # Optional. The display name of the scim tenant. Cannot exceed 32 characters.
   "name": "A String", # Identifier. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}`
   "purgeTime": "A String", # Output only. The timestamp when the scim tenant is going to be purged.
   "state": "A String", # Output only. The state of the tenant.
@@ -171,8 +171,8 @@ 
Method Details

   "claimMapping": { # Optional. Maps BYOID claims to SCIM claims.
     "a_key": "A String",
   },
-  "description": "A String", # Optional. The user-specified description of the scim tenant. Cannot exceed 256 characters.
-  "displayName": "A String", # Optional. The user-specified display name of the scim tenant. Cannot exceed 32 characters.
+  "description": "A String", # Optional. The description of the scim tenant. Cannot exceed 256 characters.
+  "displayName": "A String", # Optional. The display name of the scim tenant. Cannot exceed 32 characters.
   "name": "A String", # Identifier. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}`
   "purgeTime": "A String", # Output only. The timestamp when the scim tenant is going to be purged.
   "state": "A String", # Output only. The state of the tenant.
@@ -198,8 +198,8 @@ 
Method Details

   "claimMapping": { # Optional. Maps BYOID claims to SCIM claims.
     "a_key": "A String",
   },
-  "description": "A String", # Optional. The user-specified description of the scim tenant. Cannot exceed 256 characters.
-  "displayName": "A String", # Optional. The user-specified display name of the scim tenant. Cannot exceed 32 characters.
+  "description": "A String", # Optional. The description of the scim tenant. Cannot exceed 256 characters.
+  "displayName": "A String", # Optional. The display name of the scim tenant. Cannot exceed 32 characters.
   "name": "A String", # Identifier. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}`
   "purgeTime": "A String", # Output only. The timestamp when the scim tenant is going to be purged.
   "state": "A String", # Output only. The state of the tenant.
@@ -231,8 +231,8 @@ 
Method Details

       "claimMapping": { # Optional. Maps BYOID claims to SCIM claims.
         "a_key": "A String",
       },
-      "description": "A String", # Optional. The user-specified description of the scim tenant. Cannot exceed 256 characters.
-      "displayName": "A String", # Optional. The user-specified display name of the scim tenant. Cannot exceed 32 characters.
+      "description": "A String", # Optional. The description of the scim tenant. Cannot exceed 256 characters.
+      "displayName": "A String", # Optional. The display name of the scim tenant. Cannot exceed 32 characters.
       "name": "A String", # Identifier. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}`
       "purgeTime": "A String", # Output only. The timestamp when the scim tenant is going to be purged.
       "state": "A String", # Output only. The state of the tenant.
@@ -269,8 +269,8 @@ 
Method Details

   "claimMapping": { # Optional. Maps BYOID claims to SCIM claims.
     "a_key": "A String",
   },
-  "description": "A String", # Optional. The user-specified description of the scim tenant. Cannot exceed 256 characters.
-  "displayName": "A String", # Optional. The user-specified display name of the scim tenant. Cannot exceed 32 characters.
+  "description": "A String", # Optional. The description of the scim tenant. Cannot exceed 256 characters.
+  "displayName": "A String", # Optional. The display name of the scim tenant. Cannot exceed 32 characters.
   "name": "A String", # Identifier. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}`
   "purgeTime": "A String", # Output only. The timestamp when the scim tenant is going to be purged.
   "state": "A String", # Output only. The state of the tenant.
@@ -290,8 +290,8 @@ 
Method Details

   "claimMapping": { # Optional. Maps BYOID claims to SCIM claims.
     "a_key": "A String",
   },
-  "description": "A String", # Optional. The user-specified description of the scim tenant. Cannot exceed 256 characters.
-  "displayName": "A String", # Optional. The user-specified display name of the scim tenant. Cannot exceed 32 characters.
+  "description": "A String", # Optional. The description of the scim tenant. Cannot exceed 256 characters.
+  "displayName": "A String", # Optional. The display name of the scim tenant. Cannot exceed 32 characters.
   "name": "A String", # Identifier. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}`
   "purgeTime": "A String", # Output only. The timestamp when the scim tenant is going to be purged.
   "state": "A String", # Output only. The state of the tenant.
@@ -323,8 +323,8 @@ 
Method Details

   "claimMapping": { # Optional. Maps BYOID claims to SCIM claims.
     "a_key": "A String",
   },
-  "description": "A String", # Optional. The user-specified description of the scim tenant. Cannot exceed 256 characters.
-  "displayName": "A String", # Optional. The user-specified display name of the scim tenant. Cannot exceed 32 characters.
+  "description": "A String", # Optional. The description of the scim tenant. Cannot exceed 256 characters.
+  "displayName": "A String", # Optional. The display name of the scim tenant. Cannot exceed 32 characters.
   "name": "A String", # Identifier. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}`
   "purgeTime": "A String", # Output only. The timestamp when the scim tenant is going to be purged.
   "state": "A String", # Output only. The state of the tenant.
diff --git a/docs/dyn/iam_v1.locations.workforcePools.providers.scimTenants.tokens.html b/docs/dyn/iam_v1.locations.workforcePools.providers.scimTenants.tokens.html
index 514fa58d866..a8e343235d6 100644
--- a/docs/dyn/iam_v1.locations.workforcePools.providers.scimTenants.tokens.html
+++ b/docs/dyn/iam_v1.locations.workforcePools.providers.scimTenants.tokens.html
@@ -114,7 +114,7 @@ 
Method Details

     The object takes the form of:
 
 { # Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM Provisioning requests.
-  "displayName": "A String", # Optional. The user-specified display name of the scim token. Cannot exceed 32 characters.
+  "displayName": "A String", # Optional. The display name of the scim token. Cannot exceed 32 characters.
   "name": "A String", # Identifier. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}`
   "securityToken": "A String", # Output only. The token string. Provide this to the IdP for authentication. Will be set only during creation.
   "state": "A String", # Output only. The state of the token.
@@ -130,7 +130,7 @@ 
Method Details

   An object of the form:
 
     { # Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM Provisioning requests.
-  "displayName": "A String", # Optional. The user-specified display name of the scim token. Cannot exceed 32 characters.
+  "displayName": "A String", # Optional. The display name of the scim token. Cannot exceed 32 characters.
   "name": "A String", # Identifier. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}`
   "securityToken": "A String", # Output only. The token string. Provide this to the IdP for authentication. Will be set only during creation.
   "state": "A String", # Output only. The state of the token.
@@ -152,7 +152,7 @@ 
Method Details

   An object of the form:
 
     { # Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM Provisioning requests.
-  "displayName": "A String", # Optional. The user-specified display name of the scim token. Cannot exceed 32 characters.
+  "displayName": "A String", # Optional. The display name of the scim token. Cannot exceed 32 characters.
   "name": "A String", # Identifier. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}`
   "securityToken": "A String", # Output only. The token string. Provide this to the IdP for authentication. Will be set only during creation.
   "state": "A String", # Output only. The state of the token.
@@ -174,7 +174,7 @@ 
Method Details

   An object of the form:
 
     { # Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM Provisioning requests.
-  "displayName": "A String", # Optional. The user-specified display name of the scim token. Cannot exceed 32 characters.
+  "displayName": "A String", # Optional. The display name of the scim token. Cannot exceed 32 characters.
   "name": "A String", # Identifier. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}`
   "securityToken": "A String", # Output only. The token string. Provide this to the IdP for authentication. Will be set only during creation.
   "state": "A String", # Output only. The state of the token.
@@ -202,7 +202,7 @@ 
Method Details

   "nextPageToken": "A String", # Optional. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
   "workforcePoolProviderScimTokens": [ # Output only. A list of scim tokens.
     { # Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM Provisioning requests.
-      "displayName": "A String", # Optional. The user-specified display name of the scim token. Cannot exceed 32 characters.
+      "displayName": "A String", # Optional. The display name of the scim token. Cannot exceed 32 characters.
       "name": "A String", # Identifier. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}`
       "securityToken": "A String", # Output only. The token string. Provide this to the IdP for authentication. Will be set only during creation.
       "state": "A String", # Output only. The state of the token.
@@ -235,7 +235,7 @@ 
Method Details

     The object takes the form of:
 
 { # Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM Provisioning requests.
-  "displayName": "A String", # Optional. The user-specified display name of the scim token. Cannot exceed 32 characters.
+  "displayName": "A String", # Optional. The display name of the scim token. Cannot exceed 32 characters.
   "name": "A String", # Identifier. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}`
   "securityToken": "A String", # Output only. The token string. Provide this to the IdP for authentication. Will be set only during creation.
   "state": "A String", # Output only. The state of the token.
@@ -251,7 +251,7 @@ 
Method Details

   An object of the form:
 
     { # Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM Provisioning requests.
-  "displayName": "A String", # Optional. The user-specified display name of the scim token. Cannot exceed 32 characters.
+  "displayName": "A String", # Optional. The display name of the scim token. Cannot exceed 32 characters.
   "name": "A String", # Identifier. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}`
   "securityToken": "A String", # Output only. The token string. Provide this to the IdP for authentication. Will be set only during creation.
   "state": "A String", # Output only. The state of the token.
@@ -279,7 +279,7 @@ 
Method Details

   An object of the form:
 
     { # Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM Provisioning requests.
-  "displayName": "A String", # Optional. The user-specified display name of the scim token. Cannot exceed 32 characters.
+  "displayName": "A String", # Optional. The display name of the scim token. Cannot exceed 32 characters.
   "name": "A String", # Identifier. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}`
   "securityToken": "A String", # Output only. The token string. Provide this to the IdP for authentication. Will be set only during creation.
   "state": "A String", # Output only. The state of the token.
diff --git a/docs/dyn/memcache_v1.projects.locations.html b/docs/dyn/memcache_v1.projects.locations.html
index db5ac8f880a..e7a2d38a116 100644
--- a/docs/dyn/memcache_v1.projects.locations.html
+++ b/docs/dyn/memcache_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. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (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/memcache_v1beta2.projects.locations.html b/docs/dyn/memcache_v1beta2.projects.locations.html
index 463379f630a..eb3727857ba 100644
--- a/docs/dyn/memcache_v1beta2.projects.locations.html
+++ b/docs/dyn/memcache_v1beta2.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. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (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/workflows_v1.projects.locations.html b/docs/dyn/workflows_v1.projects.locations.html
index 0a459d759b1..c0f1914c4f5 100644
--- a/docs/dyn/workflows_v1.projects.locations.html
+++ b/docs/dyn/workflows_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. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (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/workflows_v1beta.projects.locations.html b/docs/dyn/workflows_v1beta.projects.locations.html
index f087d546abc..8928e4ccfca 100644
--- a/docs/dyn/workflows_v1beta.projects.locations.html
+++ b/docs/dyn/workflows_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. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (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/workspaceevents_v1.subscriptions.html b/docs/dyn/workspaceevents_v1.subscriptions.html
index dcd20005f82..7e5487dddf7 100644
--- a/docs/dyn/workspaceevents_v1.subscriptions.html
+++ b/docs/dyn/workspaceevents_v1.subscriptions.html
@@ -79,7 +79,7 @@ 
Instance Methods

 
Close httplib2 connections.

 

   create(body=None, validateOnly=None, x__xgafv=None)

-
Creates a Google Workspace subscription. To learn how to use this method, see [Create a Google Workspace subscription](https://developers.google.com/workspace/events/guides/create-subscription). 

+
Creates a Google Workspace subscription. To learn how to use this method, see [Create a Google Workspace subscription](https://developers.google.com/workspace/events/guides/create-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can create a subscription as: - A Chat app by specifying an authorization scope that begins with `chat.app` and getting one-time administrator approval ([Developer Preview](https://developers.google.com/workspace/preview)). To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).

 

   delete(name, allowMissing=None, etag=None, validateOnly=None, x__xgafv=None)

 
Deletes a Google Workspace subscription. To learn how to use this method, see [Delete a Google Workspace subscription](https://developers.google.com/workspace/events/guides/delete-subscription).

@@ -94,10 +94,10 @@ 
Instance Methods

 
Retrieves the next page of results.

 

   patch(name, body=None, updateMask=None, validateOnly=None, x__xgafv=None)

-
Updates or renews a Google Workspace subscription. To learn how to use this method, see [Update or renew a Google Workspace subscription](https://developers.google.com/workspace/events/guides/update-subscription).

+
Updates or renews a Google Workspace subscription. To learn how to use this method, see [Update or renew a Google Workspace subscription](https://developers.google.com/workspace/events/guides/update-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can update a subscription as: - A Chat app by specifying an authorization scope that begins with `chat.app` andgetting one-time administrator approval ([Developer Preview](https://developers.google.com/workspace/preview)). To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).

 

   reactivate(name, body=None, x__xgafv=None)

-
Reactivates a suspended Google Workspace subscription. This method resets your subscription's `State` field to `ACTIVE`. Before you use this method, you must fix the error that suspended the subscription. This method will ignore or reject any subscription that isn't currently in a suspended state. To learn how to use this method, see [Reactivate a Google Workspace subscription](https://developers.google.com/workspace/events/guides/reactivate-subscription).

+
Reactivates a suspended Google Workspace subscription. This method resets your subscription's `State` field to `ACTIVE`. Before you use this method, you must fix the error that suspended the subscription. This method will ignore or reject any subscription that isn't currently in a suspended state. To learn how to use this method, see [Reactivate a Google Workspace subscription](https://developers.google.com/workspace/events/guides/reactivate-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can reactivate a subscription as: - A Chat app by specifying an authorization scope that begins with `chat.app` andgetting one-time administrator approval ([Developer Preview](https://developers.google.com/workspace/preview)). To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).

 
Method Details

 

     close()
@@ -106,14 +106,14 @@ 
Method Details

 
 

     create(body=None, validateOnly=None, x__xgafv=None)
-  
Creates a Google Workspace subscription. To learn how to use this method, see [Create a Google Workspace subscription](https://developers.google.com/workspace/events/guides/create-subscription). 
+  
Creates a Google Workspace subscription. To learn how to use this method, see [Create a Google Workspace subscription](https://developers.google.com/workspace/events/guides/create-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can create a subscription as: - A Chat app by specifying an authorization scope that begins with `chat.app` and getting one-time administrator approval ([Developer Preview](https://developers.google.com/workspace/preview)). To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
 
 Args:
   body: object, The request body.
     The object takes the form of:
 
 { # A subscription to receive events about a Google Workspace resource. To learn more about subscriptions, see the [Google Workspace Events API overview](https://developers.google.com/workspace/events).
-  "authority": "A String", # Output only. The user who authorized the creation of the subscription. Format: `users/{user}` For Google Workspace users, the `{user}` value is the [`user.id`](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users#User.FIELDS.ids) field from the Directory API.
+  "authority": "A String", # Output only. The user who authorized the creation of the subscription. When a user authorizes the subscription, this field and the `user_authority` field have the same value and the format is: Format: `users/{user}` For Google Workspace users, the `{user}` value is the [`user.id`](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users#User.FIELDS.ids) field from the Directory API. When a Chat app authorizes the subscription, only `service_account_authority` field populates and this field is empty.
   "createTime": "A String", # Output only. The time when the subscription is created.
   "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and might be sent on update requests to ensure the client has an up-to-date value before proceeding.
   "eventTypes": [ # Required. Unordered list. Input for creating a subscription. Otherwise, output only. One or more types of events to receive about the target resource. Formatted according to the CloudEvents specification. The supported event types depend on the target resource of your subscription. For details, see [Supported Google Workspace events](https://developers.google.com/workspace/events/guides#supported-events). By default, you also receive events about the [lifecycle of your subscription](https://developers.google.com/workspace/events/guides/events-lifecycle). You don't need to specify lifecycle events for this field. If you specify an event type that doesn't exist for the target resource, the request returns an HTTP `400 Bad Request` status code.
@@ -220,7 +220,7 @@ 
Method Details

   An object of the form:
 
     { # A subscription to receive events about a Google Workspace resource. To learn more about subscriptions, see the [Google Workspace Events API overview](https://developers.google.com/workspace/events).
-  "authority": "A String", # Output only. The user who authorized the creation of the subscription. Format: `users/{user}` For Google Workspace users, the `{user}` value is the [`user.id`](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users#User.FIELDS.ids) field from the Directory API.
+  "authority": "A String", # Output only. The user who authorized the creation of the subscription. When a user authorizes the subscription, this field and the `user_authority` field have the same value and the format is: Format: `users/{user}` For Google Workspace users, the `{user}` value is the [`user.id`](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users#User.FIELDS.ids) field from the Directory API. When a Chat app authorizes the subscription, only `service_account_authority` field populates and this field is empty.
   "createTime": "A String", # Output only. The time when the subscription is created.
   "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and might be sent on update requests to ensure the client has an up-to-date value before proceeding.
   "eventTypes": [ # Required. Unordered list. Input for creating a subscription. Otherwise, output only. One or more types of events to receive about the target resource. Formatted according to the CloudEvents specification. The supported event types depend on the target resource of your subscription. For details, see [Supported Google Workspace events](https://developers.google.com/workspace/events/guides#supported-events). By default, you also receive events about the [lifecycle of your subscription](https://developers.google.com/workspace/events/guides/events-lifecycle). You don't need to specify lifecycle events for this field. If you specify an event type that doesn't exist for the target resource, the request returns an HTTP `400 Bad Request` status code.
@@ -265,7 +265,7 @@ 
Method Details

   "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.
   "subscriptions": [ # List of subscriptions.
     { # A subscription to receive events about a Google Workspace resource. To learn more about subscriptions, see the [Google Workspace Events API overview](https://developers.google.com/workspace/events).
-      "authority": "A String", # Output only. The user who authorized the creation of the subscription. Format: `users/{user}` For Google Workspace users, the `{user}` value is the [`user.id`](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users#User.FIELDS.ids) field from the Directory API.
+      "authority": "A String", # Output only. The user who authorized the creation of the subscription. When a user authorizes the subscription, this field and the `user_authority` field have the same value and the format is: Format: `users/{user}` For Google Workspace users, the `{user}` value is the [`user.id`](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users#User.FIELDS.ids) field from the Directory API. When a Chat app authorizes the subscription, only `service_account_authority` field populates and this field is empty.
       "createTime": "A String", # Output only. The time when the subscription is created.
       "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and might be sent on update requests to ensure the client has an up-to-date value before proceeding.
       "eventTypes": [ # Required. Unordered list. Input for creating a subscription. Otherwise, output only. One or more types of events to receive about the target resource. Formatted according to the CloudEvents specification. The supported event types depend on the target resource of your subscription. For details, see [Supported Google Workspace events](https://developers.google.com/workspace/events/guides#supported-events). By default, you also receive events about the [lifecycle of your subscription](https://developers.google.com/workspace/events/guides/events-lifecycle). You don't need to specify lifecycle events for this field. If you specify an event type that doesn't exist for the target resource, the request returns an HTTP `400 Bad Request` status code.
@@ -308,7 +308,7 @@ 
Method Details

 
 

     patch(name, body=None, updateMask=None, validateOnly=None, x__xgafv=None)
-  
Updates or renews a Google Workspace subscription. To learn how to use this method, see [Update or renew a Google Workspace subscription](https://developers.google.com/workspace/events/guides/update-subscription).
+  
Updates or renews a Google Workspace subscription. To learn how to use this method, see [Update or renew a Google Workspace subscription](https://developers.google.com/workspace/events/guides/update-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can update a subscription as: - A Chat app by specifying an authorization scope that begins with `chat.app` andgetting one-time administrator approval ([Developer Preview](https://developers.google.com/workspace/preview)). To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
 
 Args:
   name: string, Identifier. Resource name of the subscription. Format: `subscriptions/{subscription}` (required)
@@ -316,7 +316,7 @@ 
Method Details

     The object takes the form of:
 
 { # A subscription to receive events about a Google Workspace resource. To learn more about subscriptions, see the [Google Workspace Events API overview](https://developers.google.com/workspace/events).
-  "authority": "A String", # Output only. The user who authorized the creation of the subscription. Format: `users/{user}` For Google Workspace users, the `{user}` value is the [`user.id`](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users#User.FIELDS.ids) field from the Directory API.
+  "authority": "A String", # Output only. The user who authorized the creation of the subscription. When a user authorizes the subscription, this field and the `user_authority` field have the same value and the format is: Format: `users/{user}` For Google Workspace users, the `{user}` value is the [`user.id`](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users#User.FIELDS.ids) field from the Directory API. When a Chat app authorizes the subscription, only `service_account_authority` field populates and this field is empty.
   "createTime": "A String", # Output only. The time when the subscription is created.
   "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and might be sent on update requests to ensure the client has an up-to-date value before proceeding.
   "eventTypes": [ # Required. Unordered list. Input for creating a subscription. Otherwise, output only. One or more types of events to receive about the target resource. Formatted according to the CloudEvents specification. The supported event types depend on the target resource of your subscription. For details, see [Supported Google Workspace events](https://developers.google.com/workspace/events/guides#supported-events). By default, you also receive events about the [lifecycle of your subscription](https://developers.google.com/workspace/events/guides/events-lifecycle). You don't need to specify lifecycle events for this field. If you specify an event type that doesn't exist for the target resource, the request returns an HTTP `400 Bad Request` status code.
@@ -373,7 +373,7 @@ 
Method Details

 
 

     reactivate(name, body=None, x__xgafv=None)
-  
Reactivates a suspended Google Workspace subscription. This method resets your subscription's `State` field to `ACTIVE`. Before you use this method, you must fix the error that suspended the subscription. This method will ignore or reject any subscription that isn't currently in a suspended state. To learn how to use this method, see [Reactivate a Google Workspace subscription](https://developers.google.com/workspace/events/guides/reactivate-subscription).
+  
Reactivates a suspended Google Workspace subscription. This method resets your subscription's `State` field to `ACTIVE`. Before you use this method, you must fix the error that suspended the subscription. This method will ignore or reject any subscription that isn't currently in a suspended state. To learn how to use this method, see [Reactivate a Google Workspace subscription](https://developers.google.com/workspace/events/guides/reactivate-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can reactivate a subscription as: - A Chat app by specifying an authorization scope that begins with `chat.app` andgetting one-time administrator approval ([Developer Preview](https://developers.google.com/workspace/preview)). To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
 
 Args:
   name: string, Required. Resource name of the subscription. Format: `subscriptions/{subscription}` (required)
diff --git a/googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json b/googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json
index d07d078f142..f5282b2b326 100644
--- a/googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json
@@ -385,7 +385,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"
@@ -1182,7 +1182,7 @@
 }
 }
 },
-"revision": "20250704",
+"revision": "20250925",
 "rootUrl": "https://artifactregistry.googleapis.com/",
 "schemas": {
 "Binding": {
diff --git a/googleapiclient/discovery_cache/documents/chat.v1.json b/googleapiclient/discovery_cache/documents/chat.v1.json
index e544dde8aa8..44822334875 100644
--- a/googleapiclient/discovery_cache/documents/chat.v1.json
+++ b/googleapiclient/discovery_cache/documents/chat.v1.json
@@ -1277,7 +1277,7 @@
 "spaceEvents": {
 "methods": {
 "get": {
-"description": "Returns an event from a Google Chat space. The [event payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the resource that changed. For example, if you request an event about a new message but the message was later updated, the server returns the updated `Message` resource in the event payload. Note: The `permissionSettings` field is not returned in the Space object of the Space event data for this request. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with an [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes) appropriate for reading the requested data: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.messages.reactions.readonly` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` To get an event, the authenticated user must be a member of the space. For an example, see [Get details about an event from a Google Chat space](https://developers.google.com/workspace/chat/get-space-event).",
+"description": "Returns an event from a Google Chat space. The [event payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the resource that changed. For example, if you request an event about a new message but the message was later updated, the server returns the updated `Message` resource in the event payload. Note: The `permissionSettings` field is not returned in the Space object of the Space event data for this request. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize) with an [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes) appropriate for reading the requested data: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) in [Developer Preview](https://developers.google.com/workspace/preview) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.app.spaces` - `https://www.googleapis.com/auth/chat.app.messages.readonly` - `https://www.googleapis.com/auth/chat.app.memberships` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.messages.reactions.readonly` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` To get an event, the authenticated caller must be a member of the space. For an example, see [Get details about an event from a Google Chat space](https://developers.google.com/workspace/chat/get-space-event).",
 "flatPath": "v1/spaces/{spacesId}/spaceEvents/{spaceEventsId}",
 "httpMethod": "GET",
 "id": "chat.spaces.spaceEvents.get",
@@ -1311,7 +1311,7 @@
 ]
 },
 "list": {
-"description": "Lists events from a Google Chat space. For each event, the [payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the Chat resource. For example, if you list events about new space members, the server returns `Membership` resources that contain the latest membership details. If new members were removed during the requested period, the event payload contains an empty `Membership` resource. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with an [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes) appropriate for reading the requested data: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.messages.reactions.readonly` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` To list events, the authenticated user must be a member of the space. For an example, see [List events from a Google Chat space](https://developers.google.com/workspace/chat/list-space-events).",
+"description": "Lists events from a Google Chat space. For each event, the [payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the Chat resource. For example, if you list events about new space members, the server returns `Membership` resources that contain the latest membership details. If new members were removed during the requested period, the event payload contains an empty `Membership` resource. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize) with an [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes) appropriate for reading the requested data: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) in [Developer Preview](https://developers.google.com/workspace/preview) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.app.spaces` - `https://www.googleapis.com/auth/chat.app.messages.readonly` - `https://www.googleapis.com/auth/chat.app.memberships` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.messages.reactions.readonly` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` To list events, the authenticated caller must be a member of the space. For an example, see [List events from a Google Chat space](https://developers.google.com/workspace/chat/list-space-events).",
 "flatPath": "v1/spaces/{spacesId}/spaceEvents",
 "httpMethod": "GET",
 "id": "chat.spaces.spaceEvents.list",
@@ -1528,7 +1528,7 @@
 }
 }
 },
-"revision": "20250916",
+"revision": "20250923",
 "rootUrl": "https://chat.googleapis.com/",
 "schemas": {
 "AccessSettings": {
@@ -4818,7 +4818,7 @@
 "properties": {
 "message": {
 "$ref": "Message",
-"description": "The deleted message. Only the `name`, `createTime`, `deleteTime`, and `deletionMetadata` fields are populated."
+"description": "The deleted message. Only the `name`, `createTime`, and `deletionMetadata` fields are populated."
 }
 },
 "type": "object"
diff --git a/googleapiclient/discovery_cache/documents/cloudcommerceprocurement.v1.json b/googleapiclient/discovery_cache/documents/cloudcommerceprocurement.v1.json
index 693a7dc5dd2..ab2dcbd6d53 100644
--- a/googleapiclient/discovery_cache/documents/cloudcommerceprocurement.v1.json
+++ b/googleapiclient/discovery_cache/documents/cloudcommerceprocurement.v1.json
@@ -161,9 +161,9 @@
 "ACCOUNT_VIEW_FULL"
 ],
 "enumDescriptions": [
-"The default / unset value. The API will default to the BASIC view for ListAccounts. For GetAccount it will default to the FULL view.",
-"Include base account information. This is the default view.",
-"Include everything."
+"The default / unset value. For `GetAccount`, it defaults to the FULL view. For `ListAccounts`, it only supports BASIC view.",
+"Include base account information. This is the default view. All fields from Account are included except for the reseller_parent_billing_account field.",
+"Includes all available account information, inclusive of the accounts reseller_parent_billing_account, if it's a resold account."
 ],
 "location": "query",
 "type": "string"
@@ -518,7 +518,7 @@
 }
 }
 },
-"revision": "20250914",
+"revision": "20250923",
 "rootUrl": "https://cloudcommerceprocurement.googleapis.com/",
 "schemas": {
 "Account": {
@@ -555,7 +555,7 @@
 "type": "string"
 },
 "resellerParentBillingAccount": {
-"description": "The reseller parent billing account of the account's corresponding billing account, applicable only when the corresponding billing account is a subaccount of a reseller. Included in responses only for view ACCOUNT_VIEW_FULL. Format: billingAccounts/{billing_account_id}",
+"description": "Output only. The reseller parent billing account of the account's corresponding billing account, applicable only when the corresponding billing account is a subaccount of a reseller. Included in responses only for view: ACCOUNT_VIEW_FULL. Format: billingAccounts/{billing_account_id}",
 "type": "string"
 },
 "state": {
@@ -736,24 +736,24 @@
 "type": "string"
 },
 "newOfferEndTime": {
-"description": "Output only. The end time of the new offer. If the offer was has a term duration instead of a specified end date, this field is empty. This field is populated even if the entitlement isn't active yet. If there's no upcoming offer, the field is empty. * If the entitlement is in ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEMENT_ACTIVE, or ENTITLEMENT_PENDING_CANCELLATION state, then this field will be empty. * If the entitlement is in ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE state, then this field will be populated with the expected end time of the upcoming offer (in the future) if the upcoming offer has a specified end date. Otherwise, this field will be empty. * If the entitlement is in ENTITLEMENT_CANCELLED state, then this field will be empty.",
+"description": "Output only. The end time of the new offer, determined from the offer's specified end date. If the offer des not have a specified end date then this field is not set. This field is populated even if the entitlement isn't active yet. If there's no upcoming offer, the field is empty. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEMENT_ACTIVE, or ENTITLEMENT_PENDING_CANCELLATION, then this field is empty. * If the entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE, and the upcoming offer has a specified end date, then this field is populated with the expected end time of the upcoming offer, in the future. Otherwise, this field is empty. * If the entitlement is in the state ENTITLEMENT_CANCELLED, then this field is empty.",
 "format": "google-datetime",
 "readOnly": true,
 "type": "string"
 },
 "newOfferStartTime": {
-"description": "Output only. The timestamp when the new offer becomes effective. This field is populated even if the entitlement isn't active yet. If there's no upcoming offer, the field is empty. * If the entitlement is in ENTITLEMENT_ACTIVATION_REQUESTED state, this field will not be populated when the entitlement is not yet approved. But after the entitlement is approved, then this field will be populated with effective time of the upcoming offer. * If the entitlement is in ENTITLEMENT_ACTIVE or ENTITLEMENT_PENDING_CANCELLATION state, this field will not be populated. * If the entitlement is in ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state, this field will not be populated since the entitlement change is waiting on approval. * If the entitlement is in ENTITLEMENT_PENDING_PLAN_CHANGE state, this field will be populated with the expected effective time of the upcoming offer (in the future). * If the entitlement is in ENTITLEMENT_CANCELLED state, then this field will be empty.",
+"description": "Output only. The timestamp when the new offer becomes effective. This field is populated even if the entitlement isn't active yet. If there's no upcoming offer, the field is empty. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, this field isn't populated when the entitlement isn't yet approved. After the entitlement is approved, this field is populated with the effective time of the upcoming offer. * If the entitlement is in the state ENTITLEMENT_ACTIVE or ENTITLEMENT_PENDING_CANCELLATION, this field isn't populated. * If the entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL, this field isn't populated, because the entitlement change is waiting on approval. * If the entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE, this field is populated with the expected effective time of the upcoming offer, which is in the future. * If the entitlement is in the state ENTITLEMENT_CANCELLED, then this field is empty.",
 "format": "google-datetime",
 "readOnly": true,
 "type": "string"
 },
 "newPendingOffer": {
-"description": "Output only. The name of the offer the entitlement is switching to upon a pending plan change. Only exists if the pending plan change is moving to an offer. This field isn't populated for entitlements which aren't active yet. Format: 'projects/{project}/services/{service}/privateOffers/{offer}' OR 'projects/{project}/services/{service}/standardOffers/{offer}', depending on whether the offer is private or public. The {service} in the name is the listing service of the offer. It could be either the product service that the offer is referencing, or a generic private offer parent service. We recommend that you don't build your integration to rely on the meaning of this {service} part. * If the entitlement is in ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEMENT_ACTIVE or ENTITLEMENT_PENDING_CANCELLATION state, then this field will be empty. * If the entitlement is in ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE state, then this field will be populated with the upcoming offer. * If the entitlement is in ENTITLEMENT_CANCELLED state, then this will be empty.",
+"description": "Output only. Upon a pending plan change, the name of the offer that the entitlement is switching to. Only exists if the pending plan change is moving to an offer. This field isn't populated for entitlements which aren't active yet. Format: 'projects/{project}/services/{service}/privateOffers/{offer}' OR 'projects/{project}/services/{service}/standardOffers/{offer}', depending on whether the offer is private or public. The {service} in the name is the listing service of the offer. It could be either the product service that the offer is referencing, or a generic private offer parent service. We recommend that you don't build your integration to rely on the meaning of this {service} part. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEMENT_ACTIVE or ENTITLEMENT_PENDING_CANCELLATION, then this field is empty. * If the entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE, then this field is populated with the upcoming offer. * If the entitlement is in the state ENTITLEMENT_CANCELLED, then this is empty.",
 "readOnly": true,
 "type": "string"
 },
 "newPendingOfferDuration": {
-"description": "Output only. The duration of the new offer, in ISO 8601 duration format. This field isn't populated for entitlements which aren't active yet, only for pending offer changes. If the offer was has a specified end date instead of a duration, this field is empty. * If the entitlement is in ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEENTITLEMENT_ACTIVE, or ENTITLEMENT_PENDING_CANCELLATION state, then this field is empty. * If the entitlement is in ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE state, then this field will be populated with the duration of the upcoming offer, if the upcoming offer is does not have a specified end date. Otherwise, this field will be empty. * If the entitlement is in ENTITLEMENT_CANCELLED state, then this field will be empty.",
+"description": "Output only. The duration of the new offer, in ISO 8601 duration format. This field is populated for pending offer changes. It isn't populated for entitlements which aren't active yet. If the offer has a specified end date instead of a duration, this field is empty. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEMENT_ACTIVE, or ENTITLEMENT_PENDING_CANCELLATION, this field is empty. * If the entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE, and the upcoming offer doesn't have a specified end date, then this field is populated with the duration of the upcoming offer. Otherwise, this field is empty. * If the entitlement is in the state ENTITLEMENT_CANCELLED, then this field is empty.",
 "readOnly": true,
 "type": "string"
 },
@@ -762,17 +762,17 @@
 "type": "string"
 },
 "offer": {
-"description": "Output only. The name of the offer that was procured. Field is empty if order was not made using an offer. Format: 'projects/{project}/services/{service}/privateOffers/{offer}' OR 'projects/{project}/services/{service}/standardOffers/{offer}', depending on whether the offer is private or public. The {service} in the name is the listing service of the offer. It could be either the product service that the offer is referencing, or a generic private offer parent service. We recommend that you don't build your integration to rely on the meaning of this {service} part. * If the entitlement is in ENTITLEMENT_ACTIVATION_REQUESTED state, this field will be populated with the upcoming offer. * If the entitlement is in ENTITLEMENT_ACTIVE, ENTITLEMENT_PENDING_CANCELLATION, ENTITLEMENT_PENDING_PLAN_CHANGE, or ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state, this field will be populated with the current offer. * If the entitlement is in ENTITLEMENT_CANCELLED state, then this field will be populated with the latest offer the order was associated with.",
+"description": "Output only. The name of the offer that was procured. Field is empty if order wasn't made using an offer. Format: 'projects/{project}/services/{service}/privateOffers/{offer}' OR 'projects/{project}/services/{service}/standardOffers/{offer}', depending on whether the offer is private or public. The {service} in the name is the listing service of the offer. It could be either the product service that the offer is referencing, or a generic private offer parent service. We recommend that you don't build your integration to rely on the meaning of this {service} part. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, this field is populated with the upcoming offer. * If the entitlement is in the state ENTITLEMENT_ACTIVE, ENTITLEMENT_PENDING_CANCELLATION, ENTITLEMENT_PENDING_PLAN_CHANGE, or ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL, this field is populated with the current offer. * If the entitlement is in the state ENTITLEMENT_CANCELLED, then this field is populated with the latest offer that the order was associated with.",
 "readOnly": true,
 "type": "string"
 },
 "offerDuration": {
-"description": "Output only. The offer duration of the current offer in ISO 8601 duration format. Field is empty if entitlement was not made using an offer. If the offer has a specified end date instead of a duration, this field is empty. * If the entitlement is in ENTITLEMENT_ACTIVATION_REQUESTED state, then this field will be populated with the duration of the upcoming offer, if the upcoming offer does not have a specified end date. Otherwise, this field will be empty. * If the entitlement is in ENTITLEMENT_ACTIVE, ENTITLEMENT_PENDING_CANCELLATION, ENTITLEMENT_PENDING_PLAN_CHANGE, or ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL state, then this field will be populated with the duration of the current offer if the current offer is does not have a specific end date. Otherwise, this field will be empty. * If the entitlement is in ENTITLEMENT_CANCELLED state, then this field will be populated with the duration of the latest offer the order was associated with if that offer does not have a specific end date. Otherwise, this field will be empty.",
+"description": "Output only. The offer duration of the current offer, in ISO 8601 duration format. This is empty if the entitlement wasn't made using an offer, or if the offer has a specified end date instead of a duration. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, and the upcoming offer doesn't have a specified end date, then this field is populated with the duration of the upcoming offer. Otherwise, this field is empty. * If the entitlement is in the state ENTITLEMENT_ACTIVE, ENTITLEMENT_PENDING_CANCELLATION, ENTITLEMENT_PENDING_PLAN_CHANGE, or ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL, and the current offer doesn't have a specified end date, then this field contains the duration of the current offer. Otherwise, this field is empty. * If the entitlement is in the state ENTITLEMENT_CANCELLED, and the offer doesn't have a specified end date, then this field is populated with the duration of the latest offer that the order was associated with. Otherwise, this field is empty.",
 "readOnly": true,
 "type": "string"
 },
 "offerEndTime": {
-"description": "Output only. End time for the Offer associated with this entitlement. Note that this field value can change over time. This occurs naturally even if the offer is not changed, due to auto renewal. * If the entitlement is in ENTITLEMENT_ACTIVATION_REQUESTED state, then: * If the entitlement is not yet approved, then this field will be populated with the expected end time of the upcoming offer (in the future) if the upcoming offer has a specified end date. Otherwise this field will be empty. * If the entitlement is approved, then this field will always be populated with the expected end time of the upcoming offer (in the future). This means both this field, and the offer_duration field, can co-exist. * If the entitlement is in ENTITLEMENT_ACTIVE or ENTITLEMENT_PENDING_CANCELLATION state, then this field will be populated with the actual expected end time of the current offer (in the futre). Meaning, this field will be set, regardless of whether the offer has a specific end date or a duration. This means both this field, and the offer_duration field, can co-exist. * If the entitlement is in ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE state: * If the current offer has already ended and became pure PAYG, then this field reflects the ACTUAL end time of the current offer (in the past). * Otherwise, then this is the EXPECTED end date of the current offer (in the future). * If the entitlement is in ENTITLEMENT_CANCELLED state, then this field will be populated with the ACTUAL end time of the latest offer the order was associated with (in the past). If the entitlement was cancelled before any offer started, then this field will be empty.",
+"description": "Output only. End time for the current term of the Offer associated with this entitlement. The value of this field can change naturally over time due to auto-renewal, even if the offer isn't changed. * If the entitlement is in the state ENTITLEMENT_ACTIVATION_REQUESTED, then: * If the entitlement isn't approved yet approved, and the offer has a specified end date, then this field is populated with the expected end time of the upcoming offer, in the future. Otherwise, this field is empty. * If the entitlement is approved, then this field is populated with the expected end time of the upcoming offer, in the future. This means that this field and the field offer_duration can both exist. * If the entitlement is in the state ENTITLEMENT_ACTIVE or ENTITLEMENT_PENDING_CANCELLATION, then this field is populated with the expected end time of the current offer, in the future. This field's value is set regardless of whether the offer has a specific end date or a duration. This means that this field and the field offer_duration can both exist. * If the entitlement is in the state ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL or ENTITLEMENT_PENDING_PLAN_CHANGE: * If the entitlement's pricing model is usage based and the associated offer is a private offer whose term has ended, then this field reflects the ACTUAL end time of the entitlement's associated offer (in the past), even though the entitlement associated with this private offer does not terminate at the end of that private offer's term. * Otherwise, this is the expected end date of the current offer, in the future. * If the entitlement is in the state ENTITLEMENT_CANCELLED, then this field is populated with the end time, in the past, of the latest offer that the order was associated with. If the entitlement was cancelled before any offer started, then this field is empty.",
 "format": "google-datetime",
 "readOnly": true,
 "type": "string"
@@ -819,7 +819,7 @@
 ],
 "enumDescriptions": [
 "Default state of the entitlement. It's only set to this value when the entitlement is first created and has not been initialized.",
-"Indicates that the entitlement has been created but has not yet become active. The entitlement will remain in this state until it becomes active. If the entitlement requires provider approval, a notification is sent to the provider for the activation approval. If the provider does not approve, the entitlement is removed. If approved, the entitlement transitions to the EntitlementState.ENTITLEMENT_ACTIVE state after a delay, either a generally short processing delay or, if applicable, until the scheduled start time of the purchased offer. Plan changes are not allowed in this state. Instead, customers are expected to cancel the corresponding order and place a new order.",
+"Indicates that the entitlement has been created, but it hasn't yet become active. The entitlement remains in this state until it becomes active. If the entitlement requires provider approval, a notification is sent to the provider for the activation approval. If the provider doesn't approve, the entitlement is removed. If approved, the entitlement transitions to the EntitlementState.ENTITLEMENT_ACTIVE state after either a short processing delay or, if applicable, at the scheduled start time of the purchased offer. Plan changes aren't allowed in this state. Instead, customers are expected to cancel the corresponding order and place a new order.",
 "Indicates that the entitlement is active. The procured item is now usable and any associated billing events will start occurring. Entitlements in this state WILL renew. The analogous state for an unexpired but non-renewing entitlement is ENTITLEMENT_PENDING_CANCELLATION. In this state, the customer can decide to cancel the entitlement, which would change the state to EntitlementState.ENTITLEMENT_PENDING_CANCELLATION, and then EntitlementState.ENTITLEMENT_CANCELLED. The user can also request a change of plan, which will transition the state to EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE, and then back to EntitlementState.ENTITLEMENT_ACTIVE.",
 "Indicates that the entitlement will expire at the end of its term. This could mean the customer has elected not to renew this entitlement or the customer elected to cancel an entitlement that only expires at term end. The entitlement typically stays in this state if the entitlement/plan allows use of the underlying resource until the end of the current billing cycle. Once the billing cycle completes, the resource will transition to EntitlementState.ENTITLEMENT_CANCELLED state. The resource cannot be modified during this state.",
 "Indicates that the entitlement was cancelled. The entitlement can now be deleted.",
diff --git a/googleapiclient/discovery_cache/documents/cloudtasks.v2.json b/googleapiclient/discovery_cache/documents/cloudtasks.v2.json
index 64652eb5ba0..46a9a96d84d 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. 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"
@@ -658,7 +658,7 @@
 ]
 },
 "get": {
-"description": "Gets a task.",
+"description": "Gets a task. After a task is successfully executed or has exhausted its retry attempts, the task is deleted. A `GetTask` request for a deleted task returns a `NOT_FOUND` error.",
 "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}",
 "httpMethod": "GET",
 "id": "cloudtasks.projects.locations.queues.tasks.get",
@@ -785,7 +785,7 @@
 }
 }
 },
-"revision": "20250411",
+"revision": "20250914",
 "rootUrl": "https://cloudtasks.googleapis.com/",
 "schemas": {
 "AppEngineHttpRequest": {
@@ -968,7 +968,7 @@
 },
 "task": {
 "$ref": "Task",
-"description": "Required. The task to add. Task names have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. The user can optionally specify a task name. If a name is not specified then the system will generate a random unique task id, which will be set in the task returned in the response. If schedule_time is not set or is in the past then Cloud Tasks will set it to the current time. Task De-duplication: Explicitly specifying a task ID enables task de-duplication. If a task's ID is identical to that of an existing task or a task that was deleted or executed recently then the call will fail with ALREADY_EXISTS. The IDs of deleted tasks are not immediately available for reuse. It can take up to 4 hours (or 9 days if the task's queue was created using a queue.yaml or queue.xml) for the task ID to be released and made available again. Because there is an extra lookup cost to identify duplicate task names, these CreateTask calls have significantly increased latency. Using hashed strings for the task id or for the prefix of the task id is recommended. Choosing task ids that are sequential or have sequential prefixes, for example using a timestamp, causes an increase in latency and error rates in all task commands. The infrastructure relies on an approximately uniform distribution of task ids to store and serve tasks efficiently."
+"description": "Required. The task to add. Task names have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. The user can optionally specify a task name. If a name is not specified then the system will generate a random unique task id, which will be set in the task returned in the response. If schedule_time is not set or is in the past then Cloud Tasks will set it to the current time. Task De-duplication: Explicitly specifying a task ID enables task de-duplication. If a task's ID is identical to that of an existing task or a task that was deleted or executed recently then the call will fail with ALREADY_EXISTS. The IDs of deleted tasks are not immediately available for reuse. It can take up to 24 hours (or 9 days if the task's queue was created using a queue.yaml or queue.xml) for the task ID to be released and made available again. Because there is an extra lookup cost to identify duplicate task names, these CreateTask calls have significantly increased latency. Using hashed strings for the task id or for the prefix of the task id is recommended. Choosing task ids that are sequential or have sequential prefixes, for example using a timestamp, causes an increase in latency and error rates in all task commands. The infrastructure relies on an approximately uniform distribution of task ids to store and serve tasks efficiently."
 }
 },
 "type": "object"
@@ -1649,7 +1649,7 @@
 "description": "URI path. When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment."
 },
 "port": {
-"description": "Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.",
+"description": "Port override. When specified, replaces the port part of the task URI. For instance, for a URI \"https://www.example.com/example\" and port=123, the overridden URI becomes \"https://www.example.com:123/example\". Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.",
 "format": "int64",
 "type": "string"
 },
@@ -1666,8 +1666,8 @@
 ],
 "enumDescriptions": [
 "Scheme unspecified. Defaults to HTTPS.",
-"Convert the scheme to HTTP, e.g., https://www.google.ca will change to http://www.google.ca.",
-"Convert the scheme to HTTPS, e.g., http://www.google.ca will change to https://www.google.ca."
+"Convert the scheme to HTTP, e.g., \"https://www.example.com\" will change to \"http://www.example.com\".",
+"Convert the scheme to HTTPS, e.g., \"http://www.example.com\" will change to \"https://www.example.com\"."
 ],
 "type": "string"
 },
diff --git a/googleapiclient/discovery_cache/documents/cloudtasks.v2beta2.json b/googleapiclient/discovery_cache/documents/cloudtasks.v2beta2.json
index 3cefcf7f7a2..8b7c6bd28d9 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. 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"
@@ -941,7 +941,7 @@
 }
 }
 },
-"revision": "20250411",
+"revision": "20250914",
 "rootUrl": "https://cloudtasks.googleapis.com/",
 "schemas": {
 "AcknowledgeTaskRequest": {
@@ -1173,7 +1173,7 @@
 },
 "task": {
 "$ref": "Task",
-"description": "Required. The task to add. Task names have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. The user can optionally specify a task name. If a name is not specified then the system will generate a random unique task id, which will be set in the task returned in the response. If schedule_time is not set or is in the past then Cloud Tasks will set it to the current time. Task De-duplication: Explicitly specifying a task ID enables task de-duplication. If a task's ID is identical to that of an existing task or a task that was deleted or completed recently then the call will fail with ALREADY_EXISTS. The IDs of deleted tasks are not immediately available for reuse. It can take up to 4 hours (or 9 days if the task's queue was created using a queue.yaml or queue.xml) for the task ID to be released and made available again. Because there is an extra lookup cost to identify duplicate task names, these CreateTask calls have significantly increased latency. Using hashed strings for the task id or for the prefix of the task id is recommended. Choosing task ids that are sequential or have sequential prefixes, for example using a timestamp, causes an increase in latency and error rates in all task commands. The infrastructure relies on an approximately uniform distribution of task ids to store and serve tasks efficiently."
+"description": "Required. The task to add. Task names have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. The user can optionally specify a task name. If a name is not specified then the system will generate a random unique task id, which will be set in the task returned in the response. If schedule_time is not set or is in the past then Cloud Tasks will set it to the current time. Task De-duplication: Explicitly specifying a task ID enables task de-duplication. If a task's ID is identical to that of an existing task or a task that was deleted or completed recently then the call will fail with ALREADY_EXISTS. The IDs of deleted tasks are not immediately available for reuse. It can take up to 24 hours (or 9 days if the task's queue was created using a queue.yaml or queue.xml) for the task ID to be released and made available again. Because there is an extra lookup cost to identify duplicate task names, these CreateTask calls have significantly increased latency. Using hashed strings for the task id or for the prefix of the task id is recommended. Choosing task ids that are sequential or have sequential prefixes, for example using a timestamp, causes an increase in latency and error rates in all task commands. The infrastructure relies on an approximately uniform distribution of task ids to store and serve tasks efficiently."
 }
 },
 "type": "object"
@@ -2010,7 +2010,7 @@
 "description": "URI path. When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment."
 },
 "port": {
-"description": "Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.",
+"description": "Port override. When specified, replaces the port part of the task URI. For instance, for a URI \"https://www.example.com/example\" and port=123, the overridden URI becomes \"https://www.example.com:123/example\". Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.",
 "format": "int64",
 "type": "string"
 },
@@ -2027,8 +2027,8 @@
 ],
 "enumDescriptions": [
 "Scheme unspecified. Defaults to HTTPS.",
-"Convert the scheme to HTTP, e.g., https://www.google.ca will change to http://www.google.ca.",
-"Convert the scheme to HTTPS, e.g., http://www.google.ca will change to https://www.google.ca."
+"Convert the scheme to HTTP, e.g., \"https://www.example.com\" will change to \"http://www.example.com\".",
+"Convert the scheme to HTTPS, e.g., \"http://www.example.com\" will change to \"https://www.example.com\"."
 ],
 "type": "string"
 },
diff --git a/googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json b/googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json
index f6493de4e6f..568c45bba44 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. 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"
@@ -670,7 +670,7 @@
 ]
 },
 "get": {
-"description": "Gets a task.",
+"description": "Gets a task. After a task is successfully executed or has exhausted its retry attempts, the task is deleted. A `GetTask` request for a deleted task returns a `NOT_FOUND` error.",
 "flatPath": "v2beta3/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}",
 "httpMethod": "GET",
 "id": "cloudtasks.projects.locations.queues.tasks.get",
@@ -797,7 +797,7 @@
 }
 }
 },
-"revision": "20250411",
+"revision": "20250914",
 "rootUrl": "https://cloudtasks.googleapis.com/",
 "schemas": {
 "AppEngineHttpQueue": {
@@ -991,7 +991,7 @@
 },
 "task": {
 "$ref": "Task",
-"description": "Required. The task to add. Task names have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. The user can optionally specify a task name. If a name is not specified then the system will generate a random unique task id, which will be set in the task returned in the response. If schedule_time is not set or is in the past then Cloud Tasks will set it to the current time. Task De-duplication: Explicitly specifying a task ID enables task de-duplication. If a task's ID is identical to that of an existing task or a task that was deleted or executed recently then the call will fail with ALREADY_EXISTS. The IDs of deleted tasks are not immediately available for reuse. It can take up to 4 hours (or 9 days if the task's queue was created using a queue.yaml or queue.xml) for the task ID to be released and made available again. Because there is an extra lookup cost to identify duplicate task names, these CreateTask calls have significantly increased latency. Using hashed strings for the task id or for the prefix of the task id is recommended. Choosing task ids that are sequential or have sequential prefixes, for example using a timestamp, causes an increase in latency and error rates in all task commands. The infrastructure relies on an approximately uniform distribution of task ids to store and serve tasks efficiently."
+"description": "Required. The task to add. Task names have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. The user can optionally specify a task name. If a name is not specified then the system will generate a random unique task id, which will be set in the task returned in the response. If schedule_time is not set or is in the past then Cloud Tasks will set it to the current time. Task De-duplication: Explicitly specifying a task ID enables task de-duplication. If a task's ID is identical to that of an existing task or a task that was deleted or executed recently then the call will fail with ALREADY_EXISTS. The IDs of deleted tasks are not immediately available for reuse. It can take up to 24 hours (or 9 days if the task's queue was created using a queue.yaml or queue.xml) for the task ID to be released and made available again. Because there is an extra lookup cost to identify duplicate task names, these CreateTask calls have significantly increased latency. Using hashed strings for the task id or for the prefix of the task id is recommended. Choosing task ids that are sequential or have sequential prefixes, for example using a timestamp, causes an increase in latency and error rates in all task commands. The infrastructure relies on an approximately uniform distribution of task ids to store and serve tasks efficiently."
 }
 },
 "type": "object"
@@ -1758,7 +1758,7 @@
 "description": "URI path. When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment."
 },
 "port": {
-"description": "Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.",
+"description": "Port override. When specified, replaces the port part of the task URI. For instance, for a URI \"https://www.example.com/example\" and port=123, the overridden URI becomes \"https://www.example.com:123/example\". Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.",
 "format": "int64",
 "type": "string"
 },
@@ -1775,8 +1775,8 @@
 ],
 "enumDescriptions": [
 "Scheme unspecified. Defaults to HTTPS.",
-"Convert the scheme to HTTP, e.g., https://www.google.ca will change to http://www.google.ca.",
-"Convert the scheme to HTTPS, e.g., http://www.google.ca will change to https://www.google.ca."
+"Convert the scheme to HTTP, e.g., \"https://www.example.com\" will change to \"http://www.example.com\".",
+"Convert the scheme to HTTPS, e.g., \"http://www.example.com\" will change to \"https://www.example.com\"."
 ],
 "type": "string"
 },
diff --git a/googleapiclient/discovery_cache/documents/connectors.v1.json b/googleapiclient/discovery_cache/documents/connectors.v1.json
index 1743147ad73..8d8c9968fa6 100644
--- a/googleapiclient/discovery_cache/documents/connectors.v1.json
+++ b/googleapiclient/discovery_cache/documents/connectors.v1.json
@@ -194,7 +194,7 @@
 ],
 "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.",
+"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"
@@ -2757,7 +2757,7 @@
 }
 }
 },
-"revision": "20250826",
+"revision": "20250917",
 "rootUrl": "https://connectors.googleapis.com/",
 "schemas": {
 "AuditConfig": {
diff --git a/googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json b/googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json
index 0a54d4a3e9e..0fe6d2671fb 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. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
+"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"
@@ -518,7 +518,7 @@
 }
 }
 },
-"revision": "20250821",
+"revision": "20250918",
 "rootUrl": "https://contactcenteraiplatform.googleapis.com/",
 "schemas": {
 "AdminUser": {
diff --git a/googleapiclient/discovery_cache/documents/content.v2.1.json b/googleapiclient/discovery_cache/documents/content.v2.1.json
index fc365da109c..1155131e701 100644
--- a/googleapiclient/discovery_cache/documents/content.v2.1.json
+++ b/googleapiclient/discovery_cache/documents/content.v2.1.json
@@ -12,7 +12,7 @@
 "baseUrl": "https://shoppingcontent.googleapis.com/content/v2.1/",
 "batchPath": "batch",
 "canonicalName": "Shopping Content",
-"description": "Manage your product listings and accounts for Google Shopping",
+"description": "This API is deprecated. Please use Merchant API instead: https://developers.google.com/merchant/api. ",
 "discoveryVersion": "v1",
 "documentationLink": "https://developers.google.com/shopping-content/v2/",
 "fullyEncodeReservedExpansion": true,
@@ -4570,7 +4570,7 @@
 }
 }
 },
-"revision": "20250723",
+"revision": "20250921",
 "rootUrl": "https://shoppingcontent.googleapis.com/",
 "schemas": {
 "Account": {
diff --git a/googleapiclient/discovery_cache/documents/dataplex.v1.json b/googleapiclient/discovery_cache/documents/dataplex.v1.json
index 87ea43f7a77..8ae6671e8f7 100644
--- a/googleapiclient/discovery_cache/documents/dataplex.v1.json
+++ b/googleapiclient/discovery_cache/documents/dataplex.v1.json
@@ -7149,7 +7149,7 @@
 }
 }
 },
-"revision": "20250915",
+"revision": "20250919",
 "rootUrl": "https://dataplex.googleapis.com/",
 "schemas": {
 "Empty": {
@@ -8521,6 +8521,111 @@
 },
 "type": "object"
 },
+"GoogleCloudDataplexV1DataDocumentationResult": {
+"description": "The output of a DataDocumentation scan.",
+"id": "GoogleCloudDataplexV1DataDocumentationResult",
+"properties": {
+"tableResult": {
+"$ref": "GoogleCloudDataplexV1DataDocumentationResultTableResult",
+"description": "Output only. Table result for insights.",
+"readOnly": true
+}
+},
+"type": "object"
+},
+"GoogleCloudDataplexV1DataDocumentationResultField": {
+"description": "Column of a table with generated metadata and nested fields.",
+"id": "GoogleCloudDataplexV1DataDocumentationResultField",
+"properties": {
+"description": {
+"description": "Output only. Generated description for columns and fields.",
+"readOnly": true,
+"type": "string"
+},
+"fields": {
+"description": "Output only. Nested fields.",
+"items": {
+"$ref": "GoogleCloudDataplexV1DataDocumentationResultField"
+},
+"readOnly": true,
+"type": "array"
+},
+"name": {
+"description": "Output only. The name of the column.",
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDataplexV1DataDocumentationResultQuery": {
+"description": "A sample SQL query in data documentation.",
+"id": "GoogleCloudDataplexV1DataDocumentationResultQuery",
+"properties": {
+"description": {
+"description": "Output only. The description for the query.",
+"readOnly": true,
+"type": "string"
+},
+"sql": {
+"description": "Output only. The SQL query string which can be executed.",
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDataplexV1DataDocumentationResultSchema": {
+"description": "Schema of the table with generated metadata of columns.",
+"id": "GoogleCloudDataplexV1DataDocumentationResultSchema",
+"properties": {
+"fields": {
+"description": "Output only. The list of columns.",
+"items": {
+"$ref": "GoogleCloudDataplexV1DataDocumentationResultField"
+},
+"readOnly": true,
+"type": "array"
+}
+},
+"type": "object"
+},
+"GoogleCloudDataplexV1DataDocumentationResultTableResult": {
+"description": "Generated metadata about the table.",
+"id": "GoogleCloudDataplexV1DataDocumentationResultTableResult",
+"properties": {
+"name": {
+"description": "Output only. The service-qualified full resource name of the cloud resource. Ex: bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID",
+"readOnly": true,
+"type": "string"
+},
+"overview": {
+"description": "Output only. Generated description of the table.",
+"readOnly": true,
+"type": "string"
+},
+"queries": {
+"description": "Output only. Sample SQL queries for the table.",
+"items": {
+"$ref": "GoogleCloudDataplexV1DataDocumentationResultQuery"
+},
+"readOnly": true,
+"type": "array"
+},
+"schema": {
+"$ref": "GoogleCloudDataplexV1DataDocumentationResultSchema",
+"description": "Output only. Schema of the table with generated metadata of the columns in the schema.",
+"readOnly": true
+}
+},
+"type": "object"
+},
+"GoogleCloudDataplexV1DataDocumentationSpec": {
+"description": "DataDocumentation scan related spec.",
+"id": "GoogleCloudDataplexV1DataDocumentationSpec",
+"properties": {},
+"type": "object"
+},
 "GoogleCloudDataplexV1DataProfileResult": {
 "description": "DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result.",
 "id": "GoogleCloudDataplexV1DataProfileResult",
@@ -9517,7 +9622,7 @@
 "type": "object"
 },
 "GoogleCloudDataplexV1DataScan": {
-"description": "Represents a user-visible job which provides the insights for the related data source.For example: Data quality: generates queries based on the rules and runs against the data to get data quality check results. For more information, see Auto data quality overview (https://cloud.google.com/dataplex/docs/auto-data-quality-overview). Data profile: analyzes the data in tables and generates insights about the structure, content and relationships (such as null percent, cardinality, min/max/mean, etc). For more information, see About data profiling (https://cloud.google.com/dataplex/docs/data-profiling-overview). Data discovery: scans data in Cloud Storage buckets to extract and then catalog metadata. For more information, see Discover and catalog Cloud Storage data (https://cloud.google.com/bigquery/docs/automatic-discovery).",
+"description": "Represents a user-visible job which provides the insights for the related data source.For example: Data quality: generates queries based on the rules and runs against the data to get data quality check results. For more information, see Auto data quality overview (https://cloud.google.com/dataplex/docs/auto-data-quality-overview). Data profile: analyzes the data in tables and generates insights about the structure, content and relationships (such as null percent, cardinality, min/max/mean, etc). For more information, see About data profiling (https://cloud.google.com/dataplex/docs/data-profiling-overview). Data discovery: scans data in Cloud Storage buckets to extract and then catalog metadata. For more information, see Discover and catalog Cloud Storage data (https://cloud.google.com/bigquery/docs/automatic-discovery). Data documentation: analyzes the table details and generates insights including descriptions and sample SQL queries for the table. For more information, see Generate data insights in BigQuery (https://cloud.google.com/bigquery/docs/data-insights).",
 "id": "GoogleCloudDataplexV1DataScan",
 "properties": {
 "createTime": {
@@ -9539,6 +9644,15 @@
 "$ref": "GoogleCloudDataplexV1DataDiscoverySpec",
 "description": "Settings for a data discovery scan."
 },
+"dataDocumentationResult": {
+"$ref": "GoogleCloudDataplexV1DataDocumentationResult",
+"description": "Output only. The result of a data documentation scan.",
+"readOnly": true
+},
+"dataDocumentationSpec": {
+"$ref": "GoogleCloudDataplexV1DataDocumentationSpec",
+"description": "Settings for a data documentation scan."
+},
 "dataProfileResult": {
 "$ref": "GoogleCloudDataplexV1DataProfileResult",
 "description": "Output only. The result of a data profile scan.",
@@ -9611,13 +9725,15 @@
 "DATA_SCAN_TYPE_UNSPECIFIED",
 "DATA_QUALITY",
 "DATA_PROFILE",
-"DATA_DISCOVERY"
+"DATA_DISCOVERY",
+"DATA_DOCUMENTATION"
 ],
 "enumDescriptions": [
 "The data scan type is unspecified.",
 "Data quality scan.",
 "Data profile scan.",
-"Data discovery scan."
+"Data discovery scan.",
+"Data documentation scan."
 ],
 "readOnly": true,
 "type": "string"
@@ -9973,6 +10089,16 @@
 "description": "Output only. Settings for a data discovery scan.",
 "readOnly": true
 },
+"dataDocumentationResult": {
+"$ref": "GoogleCloudDataplexV1DataDocumentationResult",
+"description": "Output only. The result of a data documentation scan.",
+"readOnly": true
+},
+"dataDocumentationSpec": {
+"$ref": "GoogleCloudDataplexV1DataDocumentationSpec",
+"description": "Output only. Settings for a data documentation scan.",
+"readOnly": true
+},
 "dataProfileResult": {
 "$ref": "GoogleCloudDataplexV1DataProfileResult",
 "description": "Output only. The result of a data profile scan.",
@@ -10044,13 +10170,15 @@
 "DATA_SCAN_TYPE_UNSPECIFIED",
 "DATA_QUALITY",
 "DATA_PROFILE",
-"DATA_DISCOVERY"
+"DATA_DISCOVERY",
+"DATA_DOCUMENTATION"
 ],
 "enumDescriptions": [
 "The data scan type is unspecified.",
 "Data quality scan.",
 "Data profile scan.",
-"Data discovery scan."
+"Data discovery scan.",
+"Data documentation scan."
 ],
 "readOnly": true,
 "type": "string"
@@ -10072,7 +10200,7 @@
 "type": "string"
 },
 "resource": {
-"description": "Immutable. The service-qualified full resource name of the cloud resource for a DataScan job to scan against. The field could either be: Cloud Storage bucket for DataDiscoveryScan Format: //storage.googleapis.com/projects/PROJECT_ID/buckets/BUCKET_ID or BigQuery table of type \"TABLE\" for DataProfileScan/DataQualityScan Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID",
+"description": "Immutable. The service-qualified full resource name of the cloud resource for a DataScan job to scan against. The field could either be: Cloud Storage bucket for DataDiscoveryScan Format: //storage.googleapis.com/projects/PROJECT_ID/buckets/BUCKET_ID or BigQuery table of type \"TABLE\" for DataProfileScan/DataQualityScan/DataDocumentationScan Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID",
 "type": "string"
 }
 },
diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v2.json b/googleapiclient/discovery_cache/documents/displayvideo.v2.json
index 54be12b5a68..d774c5a1f31 100644
--- a/googleapiclient/discovery_cache/documents/displayvideo.v2.json
+++ b/googleapiclient/discovery_cache/documents/displayvideo.v2.json
@@ -9081,7 +9081,7 @@
 }
 }
 },
-"revision": "20250909",
+"revision": "20250925",
 "rootUrl": "https://displayvideo.googleapis.com/",
 "schemas": {
 "ActivateManualTriggerRequest": {
@@ -12073,7 +12073,8 @@
 "SDF_VERSION_7_1",
 "SDF_VERSION_8",
 "SDF_VERSION_8_1",
-"SDF_VERSION_9"
+"SDF_VERSION_9",
+"SDF_VERSION_9_1"
 ],
 "enumDeprecated": [
 false,
@@ -12092,6 +12093,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -12111,7 +12113,8 @@ false
 "SDF version 7.1. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.",
 "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. Read the [v9 migration guide](/display-video/api/structured-data-file/v9-migration-guide) before migrating to this version.",
+"SDF version 9.1."
 ],
 "type": "string"
 }
@@ -13565,7 +13568,7 @@ false
 "id": "DuplicateLineItemRequest",
 "properties": {
 "containsEuPoliticalAds": {
-"description": "Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned to the line item if the parent advertiser has declared that it does not serve EU political ads, or **the request will fail**.",
+"description": "Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.",
 "enum": [
 "EU_POLITICAL_ADVERTISING_STATUS_UNKNOWN",
 "CONTAINS_EU_POLITICAL_ADVERTISING",
@@ -13835,7 +13838,8 @@ false
 "EXCHANGE_CORE",
 "EXCHANGE_COMMERCE_GRID",
 "EXCHANGE_SPOTIFY",
-"EXCHANGE_TUBI"
+"EXCHANGE_TUBI",
+"EXCHANGE_SNAP"
 ],
 "enumDescriptions": [
 "Exchange is not specified or is unknown in this version.",
@@ -13924,7 +13928,8 @@ false
 "Core.",
 "Commerce Grid.",
 "Spotify.",
-"Tubi."
+"Tubi.",
+"Snap."
 ],
 "type": "string"
 }
@@ -14038,7 +14043,8 @@ false
 "EXCHANGE_CORE",
 "EXCHANGE_COMMERCE_GRID",
 "EXCHANGE_SPOTIFY",
-"EXCHANGE_TUBI"
+"EXCHANGE_TUBI",
+"EXCHANGE_SNAP"
 ],
 "enumDescriptions": [
 "Exchange is not specified or is unknown in this version.",
@@ -14127,7 +14133,8 @@ false
 "Core.",
 "Commerce Grid.",
 "Spotify.",
-"Tubi."
+"Tubi.",
+"Snap."
 ],
 "type": "string"
 },
@@ -14242,7 +14249,8 @@ false
 "EXCHANGE_CORE",
 "EXCHANGE_COMMERCE_GRID",
 "EXCHANGE_SPOTIFY",
-"EXCHANGE_TUBI"
+"EXCHANGE_TUBI",
+"EXCHANGE_SNAP"
 ],
 "enumDescriptions": [
 "Exchange is not specified or is unknown in this version.",
@@ -14331,7 +14339,8 @@ false
 "Core.",
 "Commerce Grid.",
 "Spotify.",
-"Tubi."
+"Tubi.",
+"Snap."
 ],
 "type": "string"
 },
@@ -14447,7 +14456,8 @@ false
 "EXCHANGE_CORE",
 "EXCHANGE_COMMERCE_GRID",
 "EXCHANGE_SPOTIFY",
-"EXCHANGE_TUBI"
+"EXCHANGE_TUBI",
+"EXCHANGE_SNAP"
 ],
 "enumDescriptions": [
 "Exchange is not specified or is unknown in this version.",
@@ -14536,7 +14546,8 @@ false
 "Core.",
 "Commerce Grid.",
 "Spotify.",
-"Tubi."
+"Tubi.",
+"Snap."
 ],
 "readOnly": true,
 "type": "string"
@@ -14815,7 +14826,7 @@ false
 "id": "GenerateDefaultLineItemRequest",
 "properties": {
 "containsEuPoliticalAds": {
-"description": "Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned to the line item if the parent advertiser has declared that it does not serve EU political ads, or **the request will fail**.",
+"description": "Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.",
 "enum": [
 "EU_POLITICAL_ADVERTISING_STATUS_UNKNOWN",
 "CONTAINS_EU_POLITICAL_ADVERTISING",
@@ -15309,7 +15320,8 @@ false
 "EXCHANGE_CORE",
 "EXCHANGE_COMMERCE_GRID",
 "EXCHANGE_SPOTIFY",
-"EXCHANGE_TUBI"
+"EXCHANGE_TUBI",
+"EXCHANGE_SNAP"
 ],
 "enumDescriptions": [
 "Exchange is not specified or is unknown in this version.",
@@ -15398,7 +15410,8 @@ false
 "Core.",
 "Commerce Grid.",
 "Spotify.",
-"Tubi."
+"Tubi.",
+"Snap."
 ],
 "type": "string"
 },
@@ -16230,7 +16243,8 @@ true
 "EXCHANGE_CORE",
 "EXCHANGE_COMMERCE_GRID",
 "EXCHANGE_SPOTIFY",
-"EXCHANGE_TUBI"
+"EXCHANGE_TUBI",
+"EXCHANGE_SNAP"
 ],
 "enumDescriptions": [
 "Exchange is not specified or is unknown in this version.",
@@ -16319,7 +16333,8 @@ true
 "Core.",
 "Commerce Grid.",
 "Spotify.",
-"Tubi."
+"Tubi.",
+"Snap."
 ],
 "type": "string"
 },
@@ -16805,7 +16820,7 @@ true
 "type": "string"
 },
 "containsEuPoliticalAds": {
-"description": "Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set when creating a new line item. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned if the parent advertiser has declared that it does not serve EU political ads, or **the `advertisers.lineItems.create` request will fail**.",
+"description": "Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.",
 "enum": [
 "EU_POLITICAL_ADVERTISING_STATUS_UNKNOWN",
 "CONTAINS_EU_POLITICAL_ADVERTISING",
@@ -19404,7 +19419,8 @@ false
 "SDF_VERSION_7_1",
 "SDF_VERSION_8",
 "SDF_VERSION_8_1",
-"SDF_VERSION_9"
+"SDF_VERSION_9",
+"SDF_VERSION_9_1"
 ],
 "enumDeprecated": [
 false,
@@ -19423,6 +19439,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -19442,7 +19459,8 @@ false
 "SDF version 7.1. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.",
 "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. Read the [v9 migration guide](/display-video/api/structured-data-file/v9-migration-guide) before migrating to this version.",
+"SDF version 9.1."
 ],
 "type": "string"
 }
@@ -19493,7 +19511,8 @@ false
 "SDF_VERSION_7_1",
 "SDF_VERSION_8",
 "SDF_VERSION_8_1",
-"SDF_VERSION_9"
+"SDF_VERSION_9",
+"SDF_VERSION_9_1"
 ],
 "enumDeprecated": [
 false,
@@ -19512,6 +19531,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -19531,7 +19551,8 @@ false
 "SDF version 7.1. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.",
 "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. Read the [v9 migration guide](/display-video/api/structured-data-file/v9-migration-guide) before migrating to this version.",
+"SDF version 9.1."
 ],
 "type": "string"
 }
@@ -21202,7 +21223,7 @@ true
 "type": "array"
 },
 "brandSafetyVendorConfigs": {
-"description": "The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZERF` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE`",
+"description": "The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZEFR` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE`",
 "items": {
 "$ref": "ThirdPartyVendorConfig"
 },
diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v3.json b/googleapiclient/discovery_cache/documents/displayvideo.v3.json
index 8e21201e052..1c24e59b276 100644
--- a/googleapiclient/discovery_cache/documents/displayvideo.v3.json
+++ b/googleapiclient/discovery_cache/documents/displayvideo.v3.json
@@ -9268,7 +9268,7 @@
 }
 }
 },
-"revision": "20250909",
+"revision": "20250925",
 "rootUrl": "https://displayvideo.googleapis.com/",
 "schemas": {
 "ActiveViewVideoViewabilityMetricConfig": {
@@ -10438,7 +10438,8 @@
 "EXCHANGE_CORE",
 "EXCHANGE_COMMERCE_GRID",
 "EXCHANGE_SPOTIFY",
-"EXCHANGE_TUBI"
+"EXCHANGE_TUBI",
+"EXCHANGE_SNAP"
 ],
 "enumDescriptions": [
 "Exchange is not specified or is unknown in this version.",
@@ -10527,7 +10528,8 @@
 "Core.",
 "Commerce Grid.",
 "Spotify.",
-"Tubi."
+"Tubi.",
+"Snap."
 ],
 "type": "string"
 },
@@ -13577,7 +13579,8 @@
 "SDF_VERSION_7_1",
 "SDF_VERSION_8",
 "SDF_VERSION_8_1",
-"SDF_VERSION_9"
+"SDF_VERSION_9",
+"SDF_VERSION_9_1"
 ],
 "enumDeprecated": [
 false,
@@ -13596,6 +13599,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -13615,7 +13619,8 @@ false
 "SDF version 7.1. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.",
 "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. Read the [v9 migration guide](/display-video/api/structured-data-file/v9-migration-guide) before migrating to this version.",
+"SDF version 9.1."
 ],
 "type": "string"
 }
@@ -15223,7 +15228,7 @@ false
 "id": "DuplicateLineItemRequest",
 "properties": {
 "containsEuPoliticalAds": {
-"description": "Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned to the line item if the parent advertiser has declared that it does not serve EU political ads, or **the request will fail**.",
+"description": "Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.",
 "enum": [
 "EU_POLITICAL_ADVERTISING_STATUS_UNKNOWN",
 "CONTAINS_EU_POLITICAL_ADVERTISING",
@@ -15533,7 +15538,8 @@ false
 "EXCHANGE_CORE",
 "EXCHANGE_COMMERCE_GRID",
 "EXCHANGE_SPOTIFY",
-"EXCHANGE_TUBI"
+"EXCHANGE_TUBI",
+"EXCHANGE_SNAP"
 ],
 "enumDescriptions": [
 "Exchange is not specified or is unknown in this version.",
@@ -15622,7 +15628,8 @@ false
 "Core.",
 "Commerce Grid.",
 "Spotify.",
-"Tubi."
+"Tubi.",
+"Snap."
 ],
 "type": "string"
 }
@@ -15736,7 +15743,8 @@ false
 "EXCHANGE_CORE",
 "EXCHANGE_COMMERCE_GRID",
 "EXCHANGE_SPOTIFY",
-"EXCHANGE_TUBI"
+"EXCHANGE_TUBI",
+"EXCHANGE_SNAP"
 ],
 "enumDescriptions": [
 "Exchange is not specified or is unknown in this version.",
@@ -15825,7 +15833,8 @@ false
 "Core.",
 "Commerce Grid.",
 "Spotify.",
-"Tubi."
+"Tubi.",
+"Snap."
 ],
 "type": "string"
 },
@@ -15940,7 +15949,8 @@ false
 "EXCHANGE_CORE",
 "EXCHANGE_COMMERCE_GRID",
 "EXCHANGE_SPOTIFY",
-"EXCHANGE_TUBI"
+"EXCHANGE_TUBI",
+"EXCHANGE_SNAP"
 ],
 "enumDescriptions": [
 "Exchange is not specified or is unknown in this version.",
@@ -16029,7 +16039,8 @@ false
 "Core.",
 "Commerce Grid.",
 "Spotify.",
-"Tubi."
+"Tubi.",
+"Snap."
 ],
 "type": "string"
 },
@@ -16145,7 +16156,8 @@ false
 "EXCHANGE_CORE",
 "EXCHANGE_COMMERCE_GRID",
 "EXCHANGE_SPOTIFY",
-"EXCHANGE_TUBI"
+"EXCHANGE_TUBI",
+"EXCHANGE_SNAP"
 ],
 "enumDescriptions": [
 "Exchange is not specified or is unknown in this version.",
@@ -16234,7 +16246,8 @@ false
 "Core.",
 "Commerce Grid.",
 "Spotify.",
-"Tubi."
+"Tubi.",
+"Snap."
 ],
 "readOnly": true,
 "type": "string"
@@ -16766,7 +16779,7 @@ false
 "id": "GenerateDefaultLineItemRequest",
 "properties": {
 "containsEuPoliticalAds": {
-"description": "Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned to the line item if the parent advertiser has declared that it does not serve EU political ads, or **the request will fail**.",
+"description": "Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.",
 "enum": [
 "EU_POLITICAL_ADVERTISING_STATUS_UNKNOWN",
 "CONTAINS_EU_POLITICAL_ADVERTISING",
@@ -17260,7 +17273,8 @@ false
 "EXCHANGE_CORE",
 "EXCHANGE_COMMERCE_GRID",
 "EXCHANGE_SPOTIFY",
-"EXCHANGE_TUBI"
+"EXCHANGE_TUBI",
+"EXCHANGE_SNAP"
 ],
 "enumDescriptions": [
 "Exchange is not specified or is unknown in this version.",
@@ -17349,7 +17363,8 @@ false
 "Core.",
 "Commerce Grid.",
 "Spotify.",
-"Tubi."
+"Tubi.",
+"Snap."
 ],
 "type": "string"
 },
@@ -18203,7 +18218,8 @@ false
 "EXCHANGE_CORE",
 "EXCHANGE_COMMERCE_GRID",
 "EXCHANGE_SPOTIFY",
-"EXCHANGE_TUBI"
+"EXCHANGE_TUBI",
+"EXCHANGE_SNAP"
 ],
 "enumDescriptions": [
 "Exchange is not specified or is unknown in this version.",
@@ -18292,7 +18308,8 @@ false
 "Core.",
 "Commerce Grid.",
 "Spotify.",
-"Tubi."
+"Tubi.",
+"Snap."
 ],
 "type": "string"
 },
@@ -18854,7 +18871,7 @@ false
 "type": "string"
 },
 "containsEuPoliticalAds": {
-"description": "Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set when creating a new line item. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned if the parent advertiser has declared that it does not serve EU political ads, or **the `advertisers.lineItems.create` request will fail**.",
+"description": "Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.",
 "enum": [
 "EU_POLITICAL_ADVERTISING_STATUS_UNKNOWN",
 "CONTAINS_EU_POLITICAL_ADVERTISING",
@@ -21488,7 +21505,8 @@ false
 "SDF_VERSION_7_1",
 "SDF_VERSION_8",
 "SDF_VERSION_8_1",
-"SDF_VERSION_9"
+"SDF_VERSION_9",
+"SDF_VERSION_9_1"
 ],
 "enumDeprecated": [
 false,
@@ -21507,6 +21525,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -21526,7 +21545,8 @@ false
 "SDF version 7.1. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.",
 "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. Read the [v9 migration guide](/display-video/api/structured-data-file/v9-migration-guide) before migrating to this version.",
+"SDF version 9.1."
 ],
 "type": "string"
 }
@@ -21577,7 +21597,8 @@ false
 "SDF_VERSION_7_1",
 "SDF_VERSION_8",
 "SDF_VERSION_8_1",
-"SDF_VERSION_9"
+"SDF_VERSION_9",
+"SDF_VERSION_9_1"
 ],
 "enumDeprecated": [
 false,
@@ -21596,6 +21617,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -21615,7 +21637,8 @@ false
 "SDF version 7.1. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.",
 "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. Read the [v9 migration guide](/display-video/api/structured-data-file/v9-migration-guide) before migrating to this version.",
+"SDF version 9.1."
 ],
 "type": "string"
 }
diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v4.json b/googleapiclient/discovery_cache/documents/displayvideo.v4.json
index b27a6f45c8f..512b1a5aa2b 100644
--- a/googleapiclient/discovery_cache/documents/displayvideo.v4.json
+++ b/googleapiclient/discovery_cache/documents/displayvideo.v4.json
@@ -9302,7 +9302,7 @@
 }
 }
 },
-"revision": "20250909",
+"revision": "20250925",
 "rootUrl": "https://displayvideo.googleapis.com/",
 "schemas": {
 "ActiveViewVideoViewabilityMetricConfig": {
@@ -10472,7 +10472,8 @@
 "EXCHANGE_CORE",
 "EXCHANGE_COMMERCE_GRID",
 "EXCHANGE_SPOTIFY",
-"EXCHANGE_TUBI"
+"EXCHANGE_TUBI",
+"EXCHANGE_SNAP"
 ],
 "enumDescriptions": [
 "Exchange is not specified or is unknown in this version.",
@@ -10561,7 +10562,8 @@
 "Core.",
 "Commerce Grid.",
 "Spotify.",
-"Tubi."
+"Tubi.",
+"Snap."
 ],
 "type": "string"
 },
@@ -13611,7 +13613,8 @@
 "SDF_VERSION_7_1",
 "SDF_VERSION_8",
 "SDF_VERSION_8_1",
-"SDF_VERSION_9"
+"SDF_VERSION_9",
+"SDF_VERSION_9_1"
 ],
 "enumDeprecated": [
 false,
@@ -13630,6 +13633,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -13649,7 +13653,8 @@ false
 "SDF version 7.1. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.",
 "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. Read the [v9 migration guide](/display-video/api/structured-data-file/v9-migration-guide) before migrating to this version.",
+"SDF version 9.1."
 ],
 "type": "string"
 }
@@ -15260,7 +15265,7 @@ false
 "id": "DuplicateLineItemRequest",
 "properties": {
 "containsEuPoliticalAds": {
-"description": "Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned to the line item if the parent advertiser has declared that it does not serve EU political ads, or **the request will fail**.",
+"description": "Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.",
 "enum": [
 "EU_POLITICAL_ADVERTISING_STATUS_UNKNOWN",
 "CONTAINS_EU_POLITICAL_ADVERTISING",
@@ -15570,7 +15575,8 @@ false
 "EXCHANGE_CORE",
 "EXCHANGE_COMMERCE_GRID",
 "EXCHANGE_SPOTIFY",
-"EXCHANGE_TUBI"
+"EXCHANGE_TUBI",
+"EXCHANGE_SNAP"
 ],
 "enumDescriptions": [
 "Exchange is not specified or is unknown in this version.",
@@ -15659,7 +15665,8 @@ false
 "Core.",
 "Commerce Grid.",
 "Spotify.",
-"Tubi."
+"Tubi.",
+"Snap."
 ],
 "type": "string"
 }
@@ -15773,7 +15780,8 @@ false
 "EXCHANGE_CORE",
 "EXCHANGE_COMMERCE_GRID",
 "EXCHANGE_SPOTIFY",
-"EXCHANGE_TUBI"
+"EXCHANGE_TUBI",
+"EXCHANGE_SNAP"
 ],
 "enumDescriptions": [
 "Exchange is not specified or is unknown in this version.",
@@ -15862,7 +15870,8 @@ false
 "Core.",
 "Commerce Grid.",
 "Spotify.",
-"Tubi."
+"Tubi.",
+"Snap."
 ],
 "type": "string"
 },
@@ -15977,7 +15986,8 @@ false
 "EXCHANGE_CORE",
 "EXCHANGE_COMMERCE_GRID",
 "EXCHANGE_SPOTIFY",
-"EXCHANGE_TUBI"
+"EXCHANGE_TUBI",
+"EXCHANGE_SNAP"
 ],
 "enumDescriptions": [
 "Exchange is not specified or is unknown in this version.",
@@ -16066,7 +16076,8 @@ false
 "Core.",
 "Commerce Grid.",
 "Spotify.",
-"Tubi."
+"Tubi.",
+"Snap."
 ],
 "type": "string"
 },
@@ -16182,7 +16193,8 @@ false
 "EXCHANGE_CORE",
 "EXCHANGE_COMMERCE_GRID",
 "EXCHANGE_SPOTIFY",
-"EXCHANGE_TUBI"
+"EXCHANGE_TUBI",
+"EXCHANGE_SNAP"
 ],
 "enumDescriptions": [
 "Exchange is not specified or is unknown in this version.",
@@ -16271,7 +16283,8 @@ false
 "Core.",
 "Commerce Grid.",
 "Spotify.",
-"Tubi."
+"Tubi.",
+"Snap."
 ],
 "readOnly": true,
 "type": "string"
@@ -16813,7 +16826,7 @@ false
 "id": "GenerateDefaultLineItemRequest",
 "properties": {
 "containsEuPoliticalAds": {
-"description": "Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned to the line item if the parent advertiser has declared that it does not serve EU political ads, or **the request will fail**.",
+"description": "Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.",
 "enum": [
 "EU_POLITICAL_ADVERTISING_STATUS_UNKNOWN",
 "CONTAINS_EU_POLITICAL_ADVERTISING",
@@ -17307,7 +17320,8 @@ false
 "EXCHANGE_CORE",
 "EXCHANGE_COMMERCE_GRID",
 "EXCHANGE_SPOTIFY",
-"EXCHANGE_TUBI"
+"EXCHANGE_TUBI",
+"EXCHANGE_SNAP"
 ],
 "enumDescriptions": [
 "Exchange is not specified or is unknown in this version.",
@@ -17396,7 +17410,8 @@ false
 "Core.",
 "Commerce Grid.",
 "Spotify.",
-"Tubi."
+"Tubi.",
+"Snap."
 ],
 "type": "string"
 },
@@ -18250,7 +18265,8 @@ false
 "EXCHANGE_CORE",
 "EXCHANGE_COMMERCE_GRID",
 "EXCHANGE_SPOTIFY",
-"EXCHANGE_TUBI"
+"EXCHANGE_TUBI",
+"EXCHANGE_SNAP"
 ],
 "enumDescriptions": [
 "Exchange is not specified or is unknown in this version.",
@@ -18339,7 +18355,8 @@ false
 "Core.",
 "Commerce Grid.",
 "Spotify.",
-"Tubi."
+"Tubi.",
+"Snap."
 ],
 "type": "string"
 },
@@ -18901,7 +18918,7 @@ false
 "type": "string"
 },
 "containsEuPoliticalAds": {
-"description": "Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. *Warning*: Starting **September 8, 2025**, this field must be set when creating a new line item. If not, either the value `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` will be assigned if the parent advertiser has declared that it does not serve EU political ads, or **the `advertisers.lineItems.create` request will fail**.",
+"description": "Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.",
 "enum": [
 "EU_POLITICAL_ADVERTISING_STATUS_UNKNOWN",
 "CONTAINS_EU_POLITICAL_ADVERTISING",
@@ -21465,7 +21482,8 @@ false
 "SDF_VERSION_7_1",
 "SDF_VERSION_8",
 "SDF_VERSION_8_1",
-"SDF_VERSION_9"
+"SDF_VERSION_9",
+"SDF_VERSION_9_1"
 ],
 "enumDeprecated": [
 false,
@@ -21484,6 +21502,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -21503,7 +21522,8 @@ false
 "SDF version 7.1. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.",
 "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. Read the [v9 migration guide](/display-video/api/structured-data-file/v9-migration-guide) before migrating to this version.",
+"SDF version 9.1."
 ],
 "type": "string"
 }
@@ -21554,7 +21574,8 @@ false
 "SDF_VERSION_7_1",
 "SDF_VERSION_8",
 "SDF_VERSION_8_1",
-"SDF_VERSION_9"
+"SDF_VERSION_9",
+"SDF_VERSION_9_1"
 ],
 "enumDeprecated": [
 false,
@@ -21573,6 +21594,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -21592,7 +21614,8 @@ false
 "SDF version 7.1. Read the [v7 migration guide](/display-video/api/structured-data-file/v7-migration-guide) before migrating to this version.",
 "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. Read the [v9 migration guide](/display-video/api/structured-data-file/v9-migration-guide) before migrating to this version.",
+"SDF version 9.1."
 ],
 "type": "string"
 }
diff --git a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json
index 934e4862361..4928334903c 100644
--- a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json
+++ b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json
@@ -206,7 +206,7 @@
 }
 }
 },
-"revision": "20250909",
+"revision": "20250922",
 "rootUrl": "https://firebaseml.googleapis.com/",
 "schemas": {
 "Date": {
@@ -1044,7 +1044,8 @@
 "BLOCKLIST",
 "PROHIBITED_CONTENT",
 "MODEL_ARMOR",
-"IMAGE_SAFETY"
+"IMAGE_SAFETY",
+"JAILBREAK"
 ],
 "enumDescriptions": [
 "The blocked reason is unspecified.",
@@ -1053,7 +1054,8 @@
 "The prompt was blocked because it contains a term from the terminology blocklist.",
 "The prompt was blocked because it contains prohibited content.",
 "The prompt was blocked by Model Armor.",
-"The prompt was blocked because it contains content that is unsafe for image generation."
+"The prompt was blocked because it contains content that is unsafe for image generation.",
+"The prompt was blocked as a jailbreak attempt."
 ],
 "readOnly": true,
 "type": "string"
@@ -1991,7 +1993,8 @@
 "HARM_CATEGORY_IMAGE_HATE",
 "HARM_CATEGORY_IMAGE_DANGEROUS_CONTENT",
 "HARM_CATEGORY_IMAGE_HARASSMENT",
-"HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT"
+"HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT",
+"HARM_CATEGORY_JAILBREAK"
 ],
 "enumDeprecated": [
 false,
@@ -2003,6 +2006,7 @@ true,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -2015,7 +2019,8 @@ false
 "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 image sexually explicit content.",
+"The harm category is for jailbreak prompts."
 ],
 "readOnly": true,
 "type": "string"
@@ -2110,7 +2115,8 @@ false
 "HARM_CATEGORY_IMAGE_HATE",
 "HARM_CATEGORY_IMAGE_DANGEROUS_CONTENT",
 "HARM_CATEGORY_IMAGE_HARASSMENT",
-"HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT"
+"HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT",
+"HARM_CATEGORY_JAILBREAK"
 ],
 "enumDeprecated": [
 false,
@@ -2122,6 +2128,7 @@ true,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -2134,7 +2141,8 @@ false
 "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 image sexually explicit content.",
+"The harm category is for jailbreak prompts."
 ],
 "type": "string"
 },
diff --git a/googleapiclient/discovery_cache/documents/gkebackup.v1.json b/googleapiclient/discovery_cache/documents/gkebackup.v1.json
index 22159c789cc..6b39e5e771c 100644
--- a/googleapiclient/discovery_cache/documents/gkebackup.v1.json
+++ b/googleapiclient/discovery_cache/documents/gkebackup.v1.json
@@ -144,7 +144,7 @@
 ],
 "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.",
+"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"
@@ -2227,7 +2227,7 @@
 }
 }
 },
-"revision": "20250813",
+"revision": "20250922",
 "rootUrl": "https://gkebackup.googleapis.com/",
 "schemas": {
 "AuditConfig": {
@@ -3021,7 +3021,7 @@
 },
 "startTime": {
 "$ref": "TimeOfDay",
-"description": "Required. Specifies the start time of the window using time of the day in UTC."
+"description": "Optional. Specifies the start time of the window using time of the day in UTC."
 }
 },
 "type": "object"
diff --git a/googleapiclient/discovery_cache/documents/iam.v1.json b/googleapiclient/discovery_cache/documents/iam.v1.json
index c7e27fe8624..c266ad4e601 100644
--- a/googleapiclient/discovery_cache/documents/iam.v1.json
+++ b/googleapiclient/discovery_cache/documents/iam.v1.json
@@ -4155,7 +4155,7 @@
 }
 }
 },
-"revision": "20250905",
+"revision": "20250919",
 "rootUrl": "https://iam.googleapis.com/",
 "schemas": {
 "AccessRestrictions": {
@@ -6242,7 +6242,7 @@ false
 "description": "Optional. Configure access restrictions on the workforce pool users. This is an optional field. If specified web sign-in can be restricted to given set of services or programmatic sign-in can be disabled for pool users."
 },
 "description": {
-"description": "Optional. A user-specified description of the pool. Cannot exceed 256 characters.",
+"description": "Optional. A description of the pool. Cannot exceed 256 characters.",
 "type": "string"
 },
 "disabled": {
@@ -6250,7 +6250,7 @@ false
 "type": "boolean"
 },
 "displayName": {
-"description": "Optional. A user-specified display name of the pool in Google Cloud Console. Cannot exceed 32 characters.",
+"description": "Optional. A display name for the pool. Cannot exceed 32 characters.",
 "type": "string"
 },
 "expireTime": {
@@ -6306,7 +6306,7 @@ false
 "type": "object"
 },
 "description": {
-"description": "Optional. A user-specified description of the provider. Cannot exceed 256 characters.",
+"description": "Optional. A description of the provider. Cannot exceed 256 characters.",
 "type": "string"
 },
 "detailedAuditLogging": {
@@ -6318,7 +6318,7 @@ false
 "type": "boolean"
 },
 "displayName": {
-"description": "Optional. A user-specified display name for the provider. Cannot exceed 32 characters.",
+"description": "Optional. A display name for the provider. Cannot exceed 32 characters.",
 "type": "string"
 },
 "expireTime": {
@@ -6430,11 +6430,11 @@ false
 "type": "object"
 },
 "description": {
-"description": "Optional. The user-specified description of the scim tenant. Cannot exceed 256 characters.",
+"description": "Optional. The description of the scim tenant. Cannot exceed 256 characters.",
 "type": "string"
 },
 "displayName": {
-"description": "Optional. The user-specified display name of the scim tenant. Cannot exceed 32 characters.",
+"description": "Optional. The display name of the scim tenant. Cannot exceed 32 characters.",
 "type": "string"
 },
 "name": {
@@ -6470,7 +6470,7 @@ false
 "id": "WorkforcePoolProviderScimToken",
 "properties": {
 "displayName": {
-"description": "Optional. The user-specified display name of the scim token. Cannot exceed 32 characters.",
+"description": "Optional. The display name of the scim token. Cannot exceed 32 characters.",
 "type": "string"
 },
 "name": {
diff --git a/googleapiclient/discovery_cache/documents/memcache.v1.json b/googleapiclient/discovery_cache/documents/memcache.v1.json
index eebc7319b8c..25f6d5de58b 100644
--- a/googleapiclient/discovery_cache/documents/memcache.v1.json
+++ b/googleapiclient/discovery_cache/documents/memcache.v1.json
@@ -144,7 +144,7 @@
 ],
 "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.",
+"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"
@@ -590,7 +590,7 @@
 }
 }
 },
-"revision": "20250821",
+"revision": "20250918",
 "rootUrl": "https://memcache.googleapis.com/",
 "schemas": {
 "ApplyParametersRequest": {
diff --git a/googleapiclient/discovery_cache/documents/memcache.v1beta2.json b/googleapiclient/discovery_cache/documents/memcache.v1beta2.json
index 80f4d1ba6d8..86152cdf139 100644
--- a/googleapiclient/discovery_cache/documents/memcache.v1beta2.json
+++ b/googleapiclient/discovery_cache/documents/memcache.v1beta2.json
@@ -144,7 +144,7 @@
 ],
 "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.",
+"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"
@@ -618,7 +618,7 @@
 }
 }
 },
-"revision": "20250821",
+"revision": "20250918",
 "rootUrl": "https://memcache.googleapis.com/",
 "schemas": {
 "ApplyParametersRequest": {
diff --git a/googleapiclient/discovery_cache/documents/workflows.v1.json b/googleapiclient/discovery_cache/documents/workflows.v1.json
index 5cbaac90750..61ec5c7c595 100644
--- a/googleapiclient/discovery_cache/documents/workflows.v1.json
+++ b/googleapiclient/discovery_cache/documents/workflows.v1.json
@@ -144,7 +144,7 @@
 ],
 "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.",
+"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"
@@ -491,7 +491,7 @@
 }
 }
 },
-"revision": "20250814",
+"revision": "20250916",
 "rootUrl": "https://workflows.googleapis.com/",
 "schemas": {
 "Empty": {
diff --git a/googleapiclient/discovery_cache/documents/workflows.v1beta.json b/googleapiclient/discovery_cache/documents/workflows.v1beta.json
index e432cf17f88..65899843e57 100644
--- a/googleapiclient/discovery_cache/documents/workflows.v1beta.json
+++ b/googleapiclient/discovery_cache/documents/workflows.v1beta.json
@@ -144,7 +144,7 @@
 ],
 "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.",
+"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"
@@ -450,7 +450,7 @@
 }
 }
 },
-"revision": "20250814",
+"revision": "20250916",
 "rootUrl": "https://workflows.googleapis.com/",
 "schemas": {
 "Empty": {
diff --git a/googleapiclient/discovery_cache/documents/workspaceevents.v1.json b/googleapiclient/discovery_cache/documents/workspaceevents.v1.json
index 1d31cff5f1f..523990d01c7 100644
--- a/googleapiclient/discovery_cache/documents/workspaceevents.v1.json
+++ b/googleapiclient/discovery_cache/documents/workspaceevents.v1.json
@@ -203,7 +203,7 @@
 "subscriptions": {
 "methods": {
 "create": {
-"description": "Creates a Google Workspace subscription. To learn how to use this method, see [Create a Google Workspace subscription](https://developers.google.com/workspace/events/guides/create-subscription). ",
+"description": "Creates a Google Workspace subscription. To learn how to use this method, see [Create a Google Workspace subscription](https://developers.google.com/workspace/events/guides/create-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can create a subscription as: - A Chat app by specifying an authorization scope that begins with `chat.app` and getting one-time administrator approval ([Developer Preview](https://developers.google.com/workspace/preview)). To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).",
 "flatPath": "v1/subscriptions",
 "httpMethod": "POST",
 "id": "workspaceevents.subscriptions.create",
@@ -385,7 +385,7 @@
 ]
 },
 "patch": {
-"description": "Updates or renews a Google Workspace subscription. To learn how to use this method, see [Update or renew a Google Workspace subscription](https://developers.google.com/workspace/events/guides/update-subscription).",
+"description": "Updates or renews a Google Workspace subscription. To learn how to use this method, see [Update or renew a Google Workspace subscription](https://developers.google.com/workspace/events/guides/update-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can update a subscription as: - A Chat app by specifying an authorization scope that begins with `chat.app` andgetting one-time administrator approval ([Developer Preview](https://developers.google.com/workspace/preview)). To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).",
 "flatPath": "v1/subscriptions/{subscriptionsId}",
 "httpMethod": "PATCH",
 "id": "workspaceevents.subscriptions.patch",
@@ -440,7 +440,7 @@
 ]
 },
 "reactivate": {
-"description": "Reactivates a suspended Google Workspace subscription. This method resets your subscription's `State` field to `ACTIVE`. Before you use this method, you must fix the error that suspended the subscription. This method will ignore or reject any subscription that isn't currently in a suspended state. To learn how to use this method, see [Reactivate a Google Workspace subscription](https://developers.google.com/workspace/events/guides/reactivate-subscription).",
+"description": "Reactivates a suspended Google Workspace subscription. This method resets your subscription's `State` field to `ACTIVE`. Before you use this method, you must fix the error that suspended the subscription. This method will ignore or reject any subscription that isn't currently in a suspended state. To learn how to use this method, see [Reactivate a Google Workspace subscription](https://developers.google.com/workspace/events/guides/reactivate-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can reactivate a subscription as: - A Chat app by specifying an authorization scope that begins with `chat.app` andgetting one-time administrator approval ([Developer Preview](https://developers.google.com/workspace/preview)). To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).",
 "flatPath": "v1/subscriptions/{subscriptionsId}:reactivate",
 "httpMethod": "POST",
 "id": "workspaceevents.subscriptions.reactivate",
@@ -486,7 +486,7 @@
 }
 }
 },
-"revision": "20250708",
+"revision": "20250921",
 "rootUrl": "https://workspaceevents.googleapis.com/",
 "schemas": {
 "ListSubscriptionsResponse": {
@@ -607,7 +607,7 @@
 "id": "Subscription",
 "properties": {
 "authority": {
-"description": "Output only. The user who authorized the creation of the subscription. Format: `users/{user}` For Google Workspace users, the `{user}` value is the [`user.id`](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users#User.FIELDS.ids) field from the Directory API.",
+"description": "Output only. The user who authorized the creation of the subscription. When a user authorizes the subscription, this field and the `user_authority` field have the same value and the format is: Format: `users/{user}` For Google Workspace users, the `{user}` value is the [`user.id`](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users#User.FIELDS.ids) field from the Directory API. When a Chat app authorizes the subscription, only `service_account_authority` field populates and this field is empty.",
 "readOnly": true,
 "type": "string"
 },