From e1e05ba663cad2b43c1e2ca7200eb6732b9de951 Mon Sep 17 00:00:00 2001
From: Yoshi Automation
+ Close httplib2 connections.
+ Looks up the configured service perimeter for a given resource Format: ['projects/{projectNumber}', 'folders/{folderNumber}'].Access Context Manager API . folders
+Instance Methods
+close()lookupConfiguredServicePerimeter(resource, x__xgafv=None)Method Details
+close()
+ Close httplib2 connections.
+lookupConfiguredServicePerimeter(resource, x__xgafv=None)
+ Looks up the configured service perimeter for a given resource Format: ['projects/{projectNumber}', 'folders/{folderNumber}'].
+
+Args:
+ resource: string, Required. The Resource to resolve (e.g. "projects/123", "folders/456"). (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A configured service perimeter returned by Access Context Manager.
+ "restrictedResource": "A String", # The resource (e.g. "projects/123", "folders/456") that directly owns/is restricted by the enforced perimeter.
+ "restrictedResourceDryRun": "A String", # The resource (e.g. "projects/123", "folders/456") that directly owns/is restricted by the dry-run perimeter.
+ "servicePerimeter": "A String", # Fully qualified name of the configured enforced perimeter. Format: `accessPolicies/{policy_id}/servicePerimeters/{perimeter_name}` This field is empty if no enforced perimeter applies.
+ "servicePerimeterDryRun": "A String", # Fully qualified name of the configured dry-run perimeter. Format: `accessPolicies/{policy_id}/servicePerimeters/{perimeter_name}` This field is empty if no dry-run perimeter configuration applies.
+}
+Instance Methods
Returns the accessPolicies Resource.
+
+ folders()
+
Returns the folders Resource.
+ @@ -94,6 +99,11 @@Returns the permissions Resource.
+
+ projects()
+
Returns the projects Resource.
+ diff --git a/docs/dyn/accesscontextmanager_v1.organizations.gcpUserAccessBindings.html b/docs/dyn/accesscontextmanager_v1.organizations.gcpUserAccessBindings.html index d472c6d1a4..b06067531f 100644 --- a/docs/dyn/accesscontextmanager_v1.organizations.gcpUserAccessBindings.html +++ b/docs/dyn/accesscontextmanager_v1.organizations.gcpUserAccessBindings.html @@ -124,13 +124,7 @@
+ close()
Close httplib2 connections.
+
+ lookupConfiguredServicePerimeter(resource, x__xgafv=None)
Looks up the configured service perimeter for a given resource Format: ['projects/{projectNumber}', 'folders/{folderNumber}'].
+close()
+ Close httplib2 connections.+
lookupConfiguredServicePerimeter(resource, x__xgafv=None)
+ Looks up the configured service perimeter for a given resource Format: ['projects/{projectNumber}', 'folders/{folderNumber}'].
+
+Args:
+ resource: string, Required. The Resource to resolve (e.g. "projects/123", "folders/456"). (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A configured service perimeter returned by Access Context Manager.
+ "restrictedResource": "A String", # The resource (e.g. "projects/123", "folders/456") that directly owns/is restricted by the enforced perimeter.
+ "restrictedResourceDryRun": "A String", # The resource (e.g. "projects/123", "folders/456") that directly owns/is restricted by the dry-run perimeter.
+ "servicePerimeter": "A String", # Fully qualified name of the configured enforced perimeter. Format: `accessPolicies/{policy_id}/servicePerimeters/{perimeter_name}` This field is empty if no enforced perimeter applies.
+ "servicePerimeterDryRun": "A String", # Fully qualified name of the configured dry-run perimeter. Format: `accessPolicies/{policy_id}/servicePerimeters/{perimeter_name}` This field is empty if no dry-run perimeter configuration applies.
+}
+
getDeployedIngressConfig(name, view=None, x__xgafv=None)
Gets the deployed ingress configuration for an organization.
+
+ getMcpServerConfig(name, x__xgafv=None)
Gets the deployed MCP server configuration for an organization. McpServerConfig is an org-scoped singleton (one per organization). The returned configuration may be up to 30 seconds out of date by default.
getProjectMapping(name, x__xgafv=None)
Gets the project ID and region for an Apigee organization.
@@ -589,6 +592,29 @@getMcpServerConfig(name, x__xgafv=None)
+ Gets the deployed MCP server configuration for an organization. McpServerConfig is an org-scoped singleton (one per organization). The returned configuration may be up to 30 seconds out of date by default.
+
+Args:
+ name: string, Required. Name of the deployed MCP server configuration for the organization in the singleton form: `organizations/{org}/mcpServerConfig`. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Deployed MCP server configuration for an organization. Response for GetMcpServerConfig. Org-scoped singleton: each organization has exactly one McpServerConfig. Multiple logical MCP servers within the same org are expressed inside the Cloud Storage blob (McpServerConfigData.hosts map), not as multiple McpServerConfig resources.
+ "mcpServerConfigDataLocation": "A String", # Output only. Cloud Storage URI to the McpServerConfigData blob in the Apigee tenant project bucket. The sidecar fetches this URI using Cloud Storage, and deserializes the. protojson blob to McpServerConfigData. Treat this as an opaque URI — its format may change. Example: gs://{apigee-tp-bucket}/apigee-mcp-config-{org}-{revision_id}.json
+ "name": "A String", # Identifier. Resource name in the singleton form: organizations/{org}/mcpServerConfig
+ "revisionCreateTime": "A String", # Output only. Time at which this McpServerConfig revision was created. Mirrors IngressConfig.revision_create_time.
+ "revisionId": "A String", # Output only. Revision ID that defines the ordering on McpServerConfig revisions. Higher values indicate more recently deployed configurations. Monotonically non-decreasing per organization. Mirrors IngressConfig.revision_id.
+ "uid": "A String", # Output only. Unique ID for the McpServerConfig that will only change if the organization is deleted and recreated.
+}
+getProjectMapping(name, x__xgafv=None)
Gets the project ID and region for an Apigee organization.
diff --git a/googleapiclient/discovery_cache/documents/apigee.v1.json b/googleapiclient/discovery_cache/documents/apigee.v1.json
index e2eeff4297..cb896abab9 100644
--- a/googleapiclient/discovery_cache/documents/apigee.v1.json
+++ b/googleapiclient/discovery_cache/documents/apigee.v1.json
@@ -314,6 +314,31 @@
"https://www.googleapis.com/auth/cloud-platform"
]
},
+"getMcpServerConfig": {
+"description": "Gets the deployed MCP server configuration for an organization. McpServerConfig is an org-scoped singleton (one per organization). The returned configuration may be up to 30 seconds out of date by default.",
+"flatPath": "v1/organizations/{organizationsId}/mcpServerConfig",
+"httpMethod": "GET",
+"id": "apigee.organizations.getMcpServerConfig",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. Name of the deployed MCP server configuration for the organization in the singleton form: `organizations/{org}/mcpServerConfig`.",
+"location": "path",
+"pattern": "^organizations/[^/]+/mcpServerConfig$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleCloudApigeeV1McpServerConfig"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
"getProjectMapping": {
"description": "Gets the project ID and region for an Apigee organization.",
"flatPath": "v1/organizations/{organizationsId}:getProjectMapping",
@@ -11964,7 +11989,7 @@
}
}
},
-"revision": "20260820",
+"revision": "20260827",
"rootUrl": "https://apigee.googleapis.com/",
"schemas": {
"EdgeConfigstoreBundleBadBundle": {
@@ -17398,6 +17423,39 @@
},
"type": "object"
},
+"GoogleCloudApigeeV1McpServerConfig": {
+"description": "Deployed MCP server configuration for an organization. Response for GetMcpServerConfig. Org-scoped singleton: each organization has exactly one McpServerConfig. Multiple logical MCP servers within the same org are expressed inside the Cloud Storage blob (McpServerConfigData.hosts map), not as multiple McpServerConfig resources.",
+"id": "GoogleCloudApigeeV1McpServerConfig",
+"properties": {
+"mcpServerConfigDataLocation": {
+"description": "Output only. Cloud Storage URI to the McpServerConfigData blob in the Apigee tenant project bucket. The sidecar fetches this URI using Cloud Storage, and deserializes the. protojson blob to McpServerConfigData. Treat this as an opaque URI \u2014 its format may change. Example: gs://{apigee-tp-bucket}/apigee-mcp-config-{org}-{revision_id}.json",
+"readOnly": true,
+"type": "string"
+},
+"name": {
+"description": "Identifier. Resource name in the singleton form: organizations/{org}/mcpServerConfig",
+"type": "string"
+},
+"revisionCreateTime": {
+"description": "Output only. Time at which this McpServerConfig revision was created. Mirrors IngressConfig.revision_create_time.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"revisionId": {
+"description": "Output only. Revision ID that defines the ordering on McpServerConfig revisions. Higher values indicate more recently deployed configurations. Monotonically non-decreasing per organization. Mirrors IngressConfig.revision_id.",
+"format": "int64",
+"readOnly": true,
+"type": "string"
+},
+"uid": {
+"description": "Output only. Unique ID for the McpServerConfig that will only change if the organization is deleted and recreated.",
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
"GoogleCloudApigeeV1Metadata": {
"description": "Encapsulates additional information about query execution.",
"id": "GoogleCloudApigeeV1Metadata",
From 280d1c9a71295d79c5fa63c711e19251baa63d89 Mon Sep 17 00:00:00 2001
From: Yoshi Automation
Date: Tue, 8 Sep 2026 07:20:11 +0000
Subject: [PATCH 08/40] feat(apihub): update the api
#### apihub:v1
The following keys were added:
- schemas.GoogleCloudApihubV1Addon.properties.boostSpecGeminiRegionId (Total Keys: 2)
The following keys were changed:
- endpoints (Total Keys: 1)
---
.../apihub_v1.projects.locations.addons.html | 2 ++
.../discovery_cache/documents/apihub.v1.json | 22 ++++++++++++++++++-
2 files changed, 23 insertions(+), 1 deletion(-)
diff --git a/docs/dyn/apihub_v1.projects.locations.addons.html b/docs/dyn/apihub_v1.projects.locations.addons.html
index 370ed29845..a2167b2292 100644
--- a/docs/dyn/apihub_v1.projects.locations.addons.html
+++ b/docs/dyn/apihub_v1.projects.locations.addons.html
@@ -110,6 +110,7 @@ Method Details
An object of the form:
{ # Addon resource.
+ "boostSpecGeminiRegionId": "A String", # Output only. The Vertex AI region where the BoostSpec Gemini model calls run for this API Hub instance. Populated only for the SpecGen addon (`system-spec-generation`); other addons leave this field empty. `gemini-2.5-flash` is not available in every API Hub region, so the effective region may differ from the API Hub instance's own region. The value follows these semantics: - `""`: BoostSpec is disabled in this region (the addon is not SpecGen, or the API Hub instance region has no configured Gemini endpoint or fallback). - Equal to the API Hub instance region: BoostSpec calls run in-region. - Differs from the API Hub instance region: BoostSpec calls run in the specified fallback region. Callers rendering this field can derive the three display states from this single field combined with the API Hub instance region.
"config": { # Configuration for the addon. # Required. The configuration of the addon.
"allDataAddonConfig": { # Configuration for addons which act on all data in the API hub. This is used to specify if the addon is enabled for all data in the API hub. # Configuration for addons which act on all data in the API hub.
"enabled": True or False, # Required. If true, the addon is enabled for all data in the API hub.
@@ -176,6 +177,7 @@ Method Details
{ # The ListAddons method's response.
"addons": [ # The list of addons.
{ # Addon resource.
+ "boostSpecGeminiRegionId": "A String", # Output only. The Vertex AI region where the BoostSpec Gemini model calls run for this API Hub instance. Populated only for the SpecGen addon (`system-spec-generation`); other addons leave this field empty. `gemini-2.5-flash` is not available in every API Hub region, so the effective region may differ from the API Hub instance's own region. The value follows these semantics: - `""`: BoostSpec is disabled in this region (the addon is not SpecGen, or the API Hub instance region has no configured Gemini endpoint or fallback). - Equal to the API Hub instance region: BoostSpec calls run in-region. - Differs from the API Hub instance region: BoostSpec calls run in the specified fallback region. Callers rendering this field can derive the three display states from this single field combined with the API Hub instance region.
"config": { # Configuration for the addon. # Required. The configuration of the addon.
"allDataAddonConfig": { # Configuration for addons which act on all data in the API hub. This is used to specify if the addon is enabled for all data in the API hub. # Configuration for addons which act on all data in the API hub.
"enabled": True or False, # Required. If true, the addon is enabled for all data in the API hub.
diff --git a/googleapiclient/discovery_cache/documents/apihub.v1.json b/googleapiclient/discovery_cache/documents/apihub.v1.json
index 8d9bc076bb..d04ae26422 100644
--- a/googleapiclient/discovery_cache/documents/apihub.v1.json
+++ b/googleapiclient/discovery_cache/documents/apihub.v1.json
@@ -49,11 +49,21 @@
},
{
"description": "Regional Endpoint",
+"endpointUrl": "https://apihub.europe-west3.rep.googleapis.com/",
+"location": "europe-west3"
+},
+{
+"description": "Regional Endpoint",
"endpointUrl": "https://apihub.europe-west9.rep.googleapis.com/",
"location": "europe-west9"
},
{
"description": "Regional Endpoint",
+"endpointUrl": "https://apihub.northamerica-northeast2.rep.googleapis.com/",
+"location": "northamerica-northeast2"
+},
+{
+"description": "Regional Endpoint",
"endpointUrl": "https://apihub.us-central1.rep.googleapis.com/",
"location": "us-central1"
},
@@ -66,6 +76,11 @@
"description": "Regional Endpoint",
"endpointUrl": "https://apihub.us-west1.rep.googleapis.com/",
"location": "us-west1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://apihub.us-west2.rep.googleapis.com/",
+"location": "us-west2"
}
],
"fullyEncodeReservedExpansion": true,
@@ -3435,7 +3450,7 @@
}
}
},
-"revision": "20260819",
+"revision": "20260831",
"rootUrl": "https://apihub.googleapis.com/",
"schemas": {
"Empty": {
@@ -3535,6 +3550,11 @@
"description": "Addon resource.",
"id": "GoogleCloudApihubV1Addon",
"properties": {
+"boostSpecGeminiRegionId": {
+"description": "Output only. The Vertex AI region where the BoostSpec Gemini model calls run for this API Hub instance. Populated only for the SpecGen addon (`system-spec-generation`); other addons leave this field empty. `gemini-2.5-flash` is not available in every API Hub region, so the effective region may differ from the API Hub instance's own region. The value follows these semantics: - `\"\"`: BoostSpec is disabled in this region (the addon is not SpecGen, or the API Hub instance region has no configured Gemini endpoint or fallback). - Equal to the API Hub instance region: BoostSpec calls run in-region. - Differs from the API Hub instance region: BoostSpec calls run in the specified fallback region. Callers rendering this field can derive the three display states from this single field combined with the API Hub instance region.",
+"readOnly": true,
+"type": "string"
+},
"config": {
"$ref": "GoogleCloudApihubV1AddonConfig",
"description": "Required. The configuration of the addon."
From 622a2c5b0ed528282c736442375d3f0a19ac050b Mon Sep 17 00:00:00 2001
From: Yoshi Automation
Date: Tue, 8 Sep 2026 07:20:11 +0000
Subject: [PATCH 09/40] feat(bigquerydatatransfer): update the api
#### bigquerydatatransfer:v1
The following keys were added:
- schemas.DataSourceParameter.properties.secretManagerAllowed (Total Keys: 2)
- schemas.ParameterConfig (Total Keys: 4)
- schemas.TransferConfig.properties.paramConfig.$ref (Total Keys: 1)
- schemas.TransferRun.properties.parameterConfig (Total Keys: 2)
---
...ydatatransfer_v1.projects.dataSources.html | 2 +
...fer_v1.projects.locations.dataSources.html | 2 +
...v1.projects.locations.transferConfigs.html | 40 +++++++++++++++++++
...ojects.locations.transferConfigs.runs.html | 10 +++++
...atransfer_v1.projects.transferConfigs.html | 40 +++++++++++++++++++
...sfer_v1.projects.transferConfigs.runs.html | 10 +++++
.../documents/bigquerydatatransfer.v1.json | 30 +++++++++++++-
7 files changed, 133 insertions(+), 1 deletion(-)
diff --git a/docs/dyn/bigquerydatatransfer_v1.projects.dataSources.html b/docs/dyn/bigquerydatatransfer_v1.projects.dataSources.html
index 899abd5d2e..2dd923494a 100644
--- a/docs/dyn/bigquerydatatransfer_v1.projects.dataSources.html
+++ b/docs/dyn/bigquerydatatransfer_v1.projects.dataSources.html
@@ -166,6 +166,7 @@ Method Details
"recurse": True or False, # Deprecated. This field has no effect.
"repeated": True or False, # Deprecated. This field has no effect.
"required": True or False, # Is parameter required.
+ "secretManagerAllowed": True or False, # Output only. If true, the parameter value can be provided through Secret Manager.
"type": "A String", # Parameter type.
"validationDescription": "A String", # Description of the requirements for this field, in case the user input does not fulfill the regex pattern or min/max values.
"validationHelpUrl": "A String", # URL to a help document to further explain the naming requirements.
@@ -232,6 +233,7 @@ Method Details
"recurse": True or False, # Deprecated. This field has no effect.
"repeated": True or False, # Deprecated. This field has no effect.
"required": True or False, # Is parameter required.
+ "secretManagerAllowed": True or False, # Output only. If true, the parameter value can be provided through Secret Manager.
"type": "A String", # Parameter type.
"validationDescription": "A String", # Description of the requirements for this field, in case the user input does not fulfill the regex pattern or min/max values.
"validationHelpUrl": "A String", # URL to a help document to further explain the naming requirements.
diff --git a/docs/dyn/bigquerydatatransfer_v1.projects.locations.dataSources.html b/docs/dyn/bigquerydatatransfer_v1.projects.locations.dataSources.html
index f15c288451..5903639c64 100644
--- a/docs/dyn/bigquerydatatransfer_v1.projects.locations.dataSources.html
+++ b/docs/dyn/bigquerydatatransfer_v1.projects.locations.dataSources.html
@@ -166,6 +166,7 @@ Method Details
"recurse": True or False, # Deprecated. This field has no effect.
"repeated": True or False, # Deprecated. This field has no effect.
"required": True or False, # Is parameter required.
+ "secretManagerAllowed": True or False, # Output only. If true, the parameter value can be provided through Secret Manager.
"type": "A String", # Parameter type.
"validationDescription": "A String", # Description of the requirements for this field, in case the user input does not fulfill the regex pattern or min/max values.
"validationHelpUrl": "A String", # URL to a help document to further explain the naming requirements.
@@ -232,6 +233,7 @@ Method Details
"recurse": True or False, # Deprecated. This field has no effect.
"repeated": True or False, # Deprecated. This field has no effect.
"required": True or False, # Is parameter required.
+ "secretManagerAllowed": True or False, # Output only. If true, the parameter value can be provided through Secret Manager.
"type": "A String", # Parameter type.
"validationDescription": "A String", # Description of the requirements for this field, in case the user input does not fulfill the regex pattern or min/max values.
"validationHelpUrl": "A String", # URL to a help document to further explain the naming requirements.
diff --git a/docs/dyn/bigquerydatatransfer_v1.projects.locations.transferConfigs.html b/docs/dyn/bigquerydatatransfer_v1.projects.locations.transferConfigs.html
index b6fc2effe2..409aa9e7ef 100644
--- a/docs/dyn/bigquerydatatransfer_v1.projects.locations.transferConfigs.html
+++ b/docs/dyn/bigquerydatatransfer_v1.projects.locations.transferConfigs.html
@@ -160,6 +160,11 @@ Method Details
"ownerInfo": { # Information about a user. # Output only. Information about the user whose credentials are used to transfer data. Populated only for `transferConfigs.get` requests. In case the user information is not available, this field will not be populated.
"email": "A String", # E-mail address of the user.
},
+ "paramConfig": { # Configuration for data source parameters. # Optional. The config for values in `params`.
+ "secretManagerManagedParams": [ # Optional. The list of parameters that are stored in Secret Manager. The value of a parameter included in this list will be interpreted as a Secret Manager key version resource name instead of a raw value. The raw value will be retrieved from Secret Manager upon execution.
+ "A String",
+ ],
+ },
"params": { # Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
"a_key": "", # Properties of the object.
},
@@ -231,6 +236,11 @@ Method Details
"ownerInfo": { # Information about a user. # Output only. Information about the user whose credentials are used to transfer data. Populated only for `transferConfigs.get` requests. In case the user information is not available, this field will not be populated.
"email": "A String", # E-mail address of the user.
},
+ "paramConfig": { # Configuration for data source parameters. # Optional. The config for values in `params`.
+ "secretManagerManagedParams": [ # Optional. The list of parameters that are stored in Secret Manager. The value of a parameter included in this list will be interpreted as a Secret Manager key version resource name instead of a raw value. The raw value will be retrieved from Secret Manager upon execution.
+ "A String",
+ ],
+ },
"params": { # Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
"a_key": "", # Properties of the object.
},
@@ -324,6 +334,11 @@ Method Details
"ownerInfo": { # Information about a user. # Output only. Information about the user whose credentials are used to transfer data. Populated only for `transferConfigs.get` requests. In case the user information is not available, this field will not be populated.
"email": "A String", # E-mail address of the user.
},
+ "paramConfig": { # Configuration for data source parameters. # Optional. The config for values in `params`.
+ "secretManagerManagedParams": [ # Optional. The list of parameters that are stored in Secret Manager. The value of a parameter included in this list will be interpreted as a Secret Manager key version resource name instead of a raw value. The raw value will be retrieved from Secret Manager upon execution.
+ "A String",
+ ],
+ },
"params": { # Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
"a_key": "", # Properties of the object.
},
@@ -405,6 +420,11 @@ Method Details
"ownerInfo": { # Information about a user. # Output only. Information about the user whose credentials are used to transfer data. Populated only for `transferConfigs.get` requests. In case the user information is not available, this field will not be populated.
"email": "A String", # E-mail address of the user.
},
+ "paramConfig": { # Configuration for data source parameters. # Optional. The config for values in `params`.
+ "secretManagerManagedParams": [ # Optional. The list of parameters that are stored in Secret Manager. The value of a parameter included in this list will be interpreted as a Secret Manager key version resource name instead of a raw value. The raw value will be retrieved from Secret Manager upon execution.
+ "A String",
+ ],
+ },
"params": { # Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
"a_key": "", # Properties of the object.
},
@@ -491,6 +511,11 @@ Method Details
"ownerInfo": { # Information about a user. # Output only. Information about the user whose credentials are used to transfer data. Populated only for `transferConfigs.get` requests. In case the user information is not available, this field will not be populated.
"email": "A String", # E-mail address of the user.
},
+ "paramConfig": { # Configuration for data source parameters. # Optional. The config for values in `params`.
+ "secretManagerManagedParams": [ # Optional. The list of parameters that are stored in Secret Manager. The value of a parameter included in this list will be interpreted as a Secret Manager key version resource name instead of a raw value. The raw value will be retrieved from Secret Manager upon execution.
+ "A String",
+ ],
+ },
"params": { # Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
"a_key": "", # Properties of the object.
},
@@ -563,6 +588,11 @@ Method Details
"ownerInfo": { # Information about a user. # Output only. Information about the user whose credentials are used to transfer data. Populated only for `transferConfigs.get` requests. In case the user information is not available, this field will not be populated.
"email": "A String", # E-mail address of the user.
},
+ "paramConfig": { # Configuration for data source parameters. # Optional. The config for values in `params`.
+ "secretManagerManagedParams": [ # Optional. The list of parameters that are stored in Secret Manager. The value of a parameter included in this list will be interpreted as a Secret Manager key version resource name instead of a raw value. The raw value will be retrieved from Secret Manager upon execution.
+ "A String",
+ ],
+ },
"params": { # Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
"a_key": "", # Properties of the object.
},
@@ -632,6 +662,11 @@ Method Details
},
"name": "A String", # Identifier. The resource name of the transfer run. Transfer run names have the form `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`. The name is ignored when creating a transfer run.
"notificationPubsubTopic": "A String", # Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes. The format for specifying a pubsub topic is: `projects/{project_id}/topics/{topic_id}`
+ "parameterConfig": { # Configuration for data source parameters. # Output only. The parameter config of the transfer run.
+ "secretManagerManagedParams": [ # Optional. The list of parameters that are stored in Secret Manager. The value of a parameter included in this list will be interpreted as a Secret Manager key version resource name instead of a raw value. The raw value will be retrieved from Secret Manager upon execution.
+ "A String",
+ ],
+ },
"params": { # Output only. Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
"a_key": "", # Properties of the object.
},
@@ -692,6 +727,11 @@ Method Details
},
"name": "A String", # Identifier. The resource name of the transfer run. Transfer run names have the form `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`. The name is ignored when creating a transfer run.
"notificationPubsubTopic": "A String", # Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes. The format for specifying a pubsub topic is: `projects/{project_id}/topics/{topic_id}`
+ "parameterConfig": { # Configuration for data source parameters. # Output only. The parameter config of the transfer run.
+ "secretManagerManagedParams": [ # Optional. The list of parameters that are stored in Secret Manager. The value of a parameter included in this list will be interpreted as a Secret Manager key version resource name instead of a raw value. The raw value will be retrieved from Secret Manager upon execution.
+ "A String",
+ ],
+ },
"params": { # Output only. Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
"a_key": "", # Properties of the object.
},
diff --git a/docs/dyn/bigquerydatatransfer_v1.projects.locations.transferConfigs.runs.html b/docs/dyn/bigquerydatatransfer_v1.projects.locations.transferConfigs.runs.html
index fd1cebc0d4..23a898c7c3 100644
--- a/docs/dyn/bigquerydatatransfer_v1.projects.locations.transferConfigs.runs.html
+++ b/docs/dyn/bigquerydatatransfer_v1.projects.locations.transferConfigs.runs.html
@@ -150,6 +150,11 @@ Method Details
},
"name": "A String", # Identifier. The resource name of the transfer run. Transfer run names have the form `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`. The name is ignored when creating a transfer run.
"notificationPubsubTopic": "A String", # Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes. The format for specifying a pubsub topic is: `projects/{project_id}/topics/{topic_id}`
+ "parameterConfig": { # Configuration for data source parameters. # Output only. The parameter config of the transfer run.
+ "secretManagerManagedParams": [ # Optional. The list of parameters that are stored in Secret Manager. The value of a parameter included in this list will be interpreted as a Secret Manager key version resource name instead of a raw value. The raw value will be retrieved from Secret Manager upon execution.
+ "A String",
+ ],
+ },
"params": { # Output only. Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
"a_key": "", # Properties of the object.
},
@@ -212,6 +217,11 @@ Method Details
},
"name": "A String", # Identifier. The resource name of the transfer run. Transfer run names have the form `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`. The name is ignored when creating a transfer run.
"notificationPubsubTopic": "A String", # Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes. The format for specifying a pubsub topic is: `projects/{project_id}/topics/{topic_id}`
+ "parameterConfig": { # Configuration for data source parameters. # Output only. The parameter config of the transfer run.
+ "secretManagerManagedParams": [ # Optional. The list of parameters that are stored in Secret Manager. The value of a parameter included in this list will be interpreted as a Secret Manager key version resource name instead of a raw value. The raw value will be retrieved from Secret Manager upon execution.
+ "A String",
+ ],
+ },
"params": { # Output only. Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
"a_key": "", # Properties of the object.
},
diff --git a/docs/dyn/bigquerydatatransfer_v1.projects.transferConfigs.html b/docs/dyn/bigquerydatatransfer_v1.projects.transferConfigs.html
index d9b0548e27..6c11522917 100644
--- a/docs/dyn/bigquerydatatransfer_v1.projects.transferConfigs.html
+++ b/docs/dyn/bigquerydatatransfer_v1.projects.transferConfigs.html
@@ -160,6 +160,11 @@ Method Details
"ownerInfo": { # Information about a user. # Output only. Information about the user whose credentials are used to transfer data. Populated only for `transferConfigs.get` requests. In case the user information is not available, this field will not be populated.
"email": "A String", # E-mail address of the user.
},
+ "paramConfig": { # Configuration for data source parameters. # Optional. The config for values in `params`.
+ "secretManagerManagedParams": [ # Optional. The list of parameters that are stored in Secret Manager. The value of a parameter included in this list will be interpreted as a Secret Manager key version resource name instead of a raw value. The raw value will be retrieved from Secret Manager upon execution.
+ "A String",
+ ],
+ },
"params": { # Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
"a_key": "", # Properties of the object.
},
@@ -231,6 +236,11 @@ Method Details
"ownerInfo": { # Information about a user. # Output only. Information about the user whose credentials are used to transfer data. Populated only for `transferConfigs.get` requests. In case the user information is not available, this field will not be populated.
"email": "A String", # E-mail address of the user.
},
+ "paramConfig": { # Configuration for data source parameters. # Optional. The config for values in `params`.
+ "secretManagerManagedParams": [ # Optional. The list of parameters that are stored in Secret Manager. The value of a parameter included in this list will be interpreted as a Secret Manager key version resource name instead of a raw value. The raw value will be retrieved from Secret Manager upon execution.
+ "A String",
+ ],
+ },
"params": { # Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
"a_key": "", # Properties of the object.
},
@@ -324,6 +334,11 @@ Method Details
"ownerInfo": { # Information about a user. # Output only. Information about the user whose credentials are used to transfer data. Populated only for `transferConfigs.get` requests. In case the user information is not available, this field will not be populated.
"email": "A String", # E-mail address of the user.
},
+ "paramConfig": { # Configuration for data source parameters. # Optional. The config for values in `params`.
+ "secretManagerManagedParams": [ # Optional. The list of parameters that are stored in Secret Manager. The value of a parameter included in this list will be interpreted as a Secret Manager key version resource name instead of a raw value. The raw value will be retrieved from Secret Manager upon execution.
+ "A String",
+ ],
+ },
"params": { # Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
"a_key": "", # Properties of the object.
},
@@ -405,6 +420,11 @@ Method Details
"ownerInfo": { # Information about a user. # Output only. Information about the user whose credentials are used to transfer data. Populated only for `transferConfigs.get` requests. In case the user information is not available, this field will not be populated.
"email": "A String", # E-mail address of the user.
},
+ "paramConfig": { # Configuration for data source parameters. # Optional. The config for values in `params`.
+ "secretManagerManagedParams": [ # Optional. The list of parameters that are stored in Secret Manager. The value of a parameter included in this list will be interpreted as a Secret Manager key version resource name instead of a raw value. The raw value will be retrieved from Secret Manager upon execution.
+ "A String",
+ ],
+ },
"params": { # Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
"a_key": "", # Properties of the object.
},
@@ -491,6 +511,11 @@ Method Details
"ownerInfo": { # Information about a user. # Output only. Information about the user whose credentials are used to transfer data. Populated only for `transferConfigs.get` requests. In case the user information is not available, this field will not be populated.
"email": "A String", # E-mail address of the user.
},
+ "paramConfig": { # Configuration for data source parameters. # Optional. The config for values in `params`.
+ "secretManagerManagedParams": [ # Optional. The list of parameters that are stored in Secret Manager. The value of a parameter included in this list will be interpreted as a Secret Manager key version resource name instead of a raw value. The raw value will be retrieved from Secret Manager upon execution.
+ "A String",
+ ],
+ },
"params": { # Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
"a_key": "", # Properties of the object.
},
@@ -563,6 +588,11 @@ Method Details
"ownerInfo": { # Information about a user. # Output only. Information about the user whose credentials are used to transfer data. Populated only for `transferConfigs.get` requests. In case the user information is not available, this field will not be populated.
"email": "A String", # E-mail address of the user.
},
+ "paramConfig": { # Configuration for data source parameters. # Optional. The config for values in `params`.
+ "secretManagerManagedParams": [ # Optional. The list of parameters that are stored in Secret Manager. The value of a parameter included in this list will be interpreted as a Secret Manager key version resource name instead of a raw value. The raw value will be retrieved from Secret Manager upon execution.
+ "A String",
+ ],
+ },
"params": { # Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
"a_key": "", # Properties of the object.
},
@@ -632,6 +662,11 @@ Method Details
},
"name": "A String", # Identifier. The resource name of the transfer run. Transfer run names have the form `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`. The name is ignored when creating a transfer run.
"notificationPubsubTopic": "A String", # Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes. The format for specifying a pubsub topic is: `projects/{project_id}/topics/{topic_id}`
+ "parameterConfig": { # Configuration for data source parameters. # Output only. The parameter config of the transfer run.
+ "secretManagerManagedParams": [ # Optional. The list of parameters that are stored in Secret Manager. The value of a parameter included in this list will be interpreted as a Secret Manager key version resource name instead of a raw value. The raw value will be retrieved from Secret Manager upon execution.
+ "A String",
+ ],
+ },
"params": { # Output only. Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
"a_key": "", # Properties of the object.
},
@@ -692,6 +727,11 @@ Method Details
},
"name": "A String", # Identifier. The resource name of the transfer run. Transfer run names have the form `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`. The name is ignored when creating a transfer run.
"notificationPubsubTopic": "A String", # Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes. The format for specifying a pubsub topic is: `projects/{project_id}/topics/{topic_id}`
+ "parameterConfig": { # Configuration for data source parameters. # Output only. The parameter config of the transfer run.
+ "secretManagerManagedParams": [ # Optional. The list of parameters that are stored in Secret Manager. The value of a parameter included in this list will be interpreted as a Secret Manager key version resource name instead of a raw value. The raw value will be retrieved from Secret Manager upon execution.
+ "A String",
+ ],
+ },
"params": { # Output only. Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
"a_key": "", # Properties of the object.
},
diff --git a/docs/dyn/bigquerydatatransfer_v1.projects.transferConfigs.runs.html b/docs/dyn/bigquerydatatransfer_v1.projects.transferConfigs.runs.html
index e5786aa1e1..662d43122f 100644
--- a/docs/dyn/bigquerydatatransfer_v1.projects.transferConfigs.runs.html
+++ b/docs/dyn/bigquerydatatransfer_v1.projects.transferConfigs.runs.html
@@ -150,6 +150,11 @@ Method Details
},
"name": "A String", # Identifier. The resource name of the transfer run. Transfer run names have the form `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`. The name is ignored when creating a transfer run.
"notificationPubsubTopic": "A String", # Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes. The format for specifying a pubsub topic is: `projects/{project_id}/topics/{topic_id}`
+ "parameterConfig": { # Configuration for data source parameters. # Output only. The parameter config of the transfer run.
+ "secretManagerManagedParams": [ # Optional. The list of parameters that are stored in Secret Manager. The value of a parameter included in this list will be interpreted as a Secret Manager key version resource name instead of a raw value. The raw value will be retrieved from Secret Manager upon execution.
+ "A String",
+ ],
+ },
"params": { # Output only. Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
"a_key": "", # Properties of the object.
},
@@ -212,6 +217,11 @@ Method Details
},
"name": "A String", # Identifier. The resource name of the transfer run. Transfer run names have the form `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`. The name is ignored when creating a transfer run.
"notificationPubsubTopic": "A String", # Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes. The format for specifying a pubsub topic is: `projects/{project_id}/topics/{topic_id}`
+ "parameterConfig": { # Configuration for data source parameters. # Output only. The parameter config of the transfer run.
+ "secretManagerManagedParams": [ # Optional. The list of parameters that are stored in Secret Manager. The value of a parameter included in this list will be interpreted as a Secret Manager key version resource name instead of a raw value. The raw value will be retrieved from Secret Manager upon execution.
+ "A String",
+ ],
+ },
"params": { # Output only. Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
"a_key": "", # Properties of the object.
},
diff --git a/googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json b/googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json
index b54eaf6441..91035e9692 100644
--- a/googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json
+++ b/googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json
@@ -1651,7 +1651,7 @@
}
}
},
-"revision": "20260703",
+"revision": "20260905",
"rootUrl": "https://bigquerydatatransfer.googleapis.com/",
"schemas": {
"CheckValidCredsRequest": {
@@ -1859,6 +1859,11 @@
"description": "Is parameter required.",
"type": "boolean"
},
+"secretManagerAllowed": {
+"description": "Output only. If true, the parameter value can be provided through Secret Manager.",
+"readOnly": true,
+"type": "boolean"
+},
"type": {
"description": "Parameter type.",
"enum": [
@@ -2145,6 +2150,20 @@
},
"type": "object"
},
+"ParameterConfig": {
+"description": "Configuration for data source parameters.",
+"id": "ParameterConfig",
+"properties": {
+"secretManagerManagedParams": {
+"description": "Optional. The list of parameters that are stored in Secret Manager. The value of a parameter included in this list will be interpreted as a Secret Manager key version resource name instead of a raw value. The raw value will be retrieved from Secret Manager upon execution.",
+"items": {
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
"PartitionDetail": {
"description": "Partition details related to hierarchy.",
"id": "PartitionDetail",
@@ -2414,6 +2433,10 @@
"description": "Output only. Information about the user whose credentials are used to transfer data. Populated only for `transferConfigs.get` requests. In case the user information is not available, this field will not be populated.",
"readOnly": true
},
+"paramConfig": {
+"$ref": "ParameterConfig",
+"description": "Optional. The config for values in `params`."
+},
"params": {
"additionalProperties": {
"description": "Properties of the object.",
@@ -2648,6 +2671,11 @@
"readOnly": true,
"type": "string"
},
+"parameterConfig": {
+"$ref": "ParameterConfig",
+"description": "Output only. The parameter config of the transfer run.",
+"readOnly": true
+},
"params": {
"additionalProperties": {
"description": "Properties of the object.",
From 7978f61e2f782dd788b717a31d0a8a70115a8c10 Mon Sep 17 00:00:00 2001
From: Yoshi Automation
Date: Tue, 8 Sep 2026 07:20:11 +0000
Subject: [PATCH 10/40] feat(ces): update the api
#### ces:v1
The following keys were added:
- resources.projects.resources.locations.resources.apps.resources.versions.methods.patch (Total Keys: 15)
- schemas.Agent.properties.remoteA2aAgent.$ref (Total Keys: 1)
- schemas.AgentRegistryDeployment (Total Keys: 4)
- schemas.AgentRemoteA2aAgent (Total Keys: 3)
- schemas.AppVersion.properties.updateTime (Total Keys: 3)
- schemas.AudioProcessingConfig.properties.customVoiceSamples (Total Keys: 2)
- schemas.Citations.properties.inlineCitations (Total Keys: 2)
- schemas.CitationsInlineCitation (Total Keys: 9)
- schemas.CustomVoiceSample (Total Keys: 10)
- schemas.Deployment.properties.agentRegistryDeployment.$ref (Total Keys: 1)
- schemas.Image.properties.altText.type (Total Keys: 1)
- schemas.RemoteA2aConfig (Total Keys: 11)
- schemas.SessionOutput.properties.progress.type (Total Keys: 1)
#### ces:v1beta
The following keys were added:
- resources.projects.resources.locations.resources.apps.resources.versions.methods.patch (Total Keys: 15)
- schemas.Agent.properties.remoteA2aAgent.$ref (Total Keys: 1)
- schemas.AgentRegistryDeployment (Total Keys: 4)
- schemas.AgentRemoteA2aAgent (Total Keys: 3)
- schemas.AppVersion.properties.updateTime (Total Keys: 3)
- schemas.AudioProcessingConfig.properties.customVoiceSamples (Total Keys: 2)
- schemas.Citations.properties.inlineCitations (Total Keys: 2)
- schemas.CitationsInlineCitation (Total Keys: 9)
- schemas.CustomVoiceSample (Total Keys: 10)
- schemas.Deployment.properties.agentRegistryDeployment.$ref (Total Keys: 1)
- schemas.Image.properties.altText.type (Total Keys: 1)
- schemas.RemoteA2aConfig (Total Keys: 11)
- schemas.SessionOutput.properties.progress.type (Total Keys: 1)
---
...ces_v1.projects.locations.apps.agents.html | 432 +++
...projects.locations.apps.conversations.html | 4 +
...1.projects.locations.apps.deployments.html | 18 +
...s_v1.projects.locations.apps.examples.html | 6 +
docs/dyn/ces_v1.projects.locations.apps.html | 59 +
...s_v1.projects.locations.apps.sessions.html | 28 +
...s_v1.projects.locations.apps.versions.html | 3160 ++++++++++++++++
...v1beta.projects.locations.apps.agents.html | 432 +++
...projects.locations.apps.conversations.html | 4 +
...a.projects.locations.apps.deployments.html | 18 +
...a.projects.locations.apps.evaluations.html | 66 +
...ts.locations.apps.evaluations.results.html | 8 +
...beta.projects.locations.apps.examples.html | 6 +
.../ces_v1beta.projects.locations.apps.html | 131 +
...beta.projects.locations.apps.sessions.html | 28 +
...beta.projects.locations.apps.versions.html | 3248 +++++++++++++++++
.../discovery_cache/documents/ces.v1.json | 195 +-
.../discovery_cache/documents/ces.v1beta.json | 195 +-
18 files changed, 8036 insertions(+), 2 deletions(-)
diff --git a/docs/dyn/ces_v1.projects.locations.apps.agents.html b/docs/dyn/ces_v1.projects.locations.apps.agents.html
index d0ffbd6b99..92d9beb190 100644
--- a/docs/dyn/ces_v1.projects.locations.apps.agents.html
+++ b/docs/dyn/ces_v1.projects.locations.apps.agents.html
@@ -178,6 +178,78 @@ Method Details
"temperature": 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
},
"name": "A String", # Identifier. The unique identifier of the agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
+ "remoteA2aAgent": { # The agent which will transfer execution to a remote [A2A](https://github.com/a2aproject/A2A) agent. # Optional. The remote [A2A](https://github.com/a2aproject/A2A) agent to be used for the agent execution.
+ "a2aConfig": { # Shared configuration for connecting to a remote [A2A](https://github.com/a2aproject/A2A) agent. # Required. The A2A connection configuration.
+ "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Optional. The full agent card defined inline.
+ "description": "A String", # Required. A description of the agent's domain of action/solution space.
+ "name": "A String", # Required. A human-readable name for the agent.
+ "skills": [ # Required. Skills represent a unit of ability an agent can perform. This may somewhat abstract but represents a more focused set of actions that the agent is highly likely to succeed at.
+ { # Represents a distinct capability or function that an agent can perform.
+ "description": "A String", # Required. A detailed description of the skill.
+ "examples": [ # Example prompts or scenarios that this skill can handle.
+ "A String",
+ ],
+ "id": "A String", # Required. A unique identifier for the agent's skill.
+ "inputModes": [ # The set of supported input media types for this skill, overriding the agent's defaults.
+ "A String",
+ ],
+ "name": "A String", # Required. A human-readable name for the skill.
+ "outputModes": [ # The set of supported output media types for this skill, overriding the agent's defaults.
+ "A String",
+ ],
+ "tags": [ # Required. A set of keywords describing the skill's capabilities.
+ "A String",
+ ],
+ },
+ ],
+ "supportedInterfaces": [ # Required. Ordered list of supported interfaces. The first entry is preferred.
+ { # Declares a combination of a target URL, transport and protocol version for interacting with the agent. This allows agents to expose the same functionality over multiple protocol binding mechanisms.
+ "protocolBinding": "A String", # Required. The protocol binding supported at this URL. This is an open form string, to be easily extended for other protocol bindings. The core ones officially supported are `JSONRPC`, `GRPC` and `HTTP+JSON`.
+ "protocolVersion": "A String", # Required. The version of the A2A protocol this interface exposes. Use the latest supported minor version per major version. Examples: "0.3", "1.0"
+ "tenant": "A String", # Tenant ID to be used in the request when calling the agent.
+ "url": "A String", # Required. The URL where this interface is available. Must be a valid absolute HTTPS URL in production. Example: "https://api.example.com/a2a/v1", "https://grpc.example.com/a2a"
+ },
+ ],
+ "version": "A String", # Required. The version of the agent.
+ },
+ "agentRegistry": "A String", # Optional. Reference to the agent in the Agent Registry. Format: `projects/{project}/locations/{location}/agents/{agent}`
+ "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication configuration for calling the remote agent. Optional if the registry reference already handles authentication.
+ "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth.
+ "apiKeySecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
+ "requestLocation": "A String", # Required. Key location in the request.
+ },
+ "bearerTokenConfig": { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth.
+ "token": "A String", # Required. The bearer token. Must be in the format `$context.variables.`.
+ },
+ "oauthConfig": { # Configurations for authentication with OAuth. # Optional. Config for OAuth.
+ "clientId": "A String", # Required. The client ID from the OAuth provider.
+ "clientSecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "oauthGrantType": "A String", # Required. OAuth grant types.
+ "scopes": [ # Optional. The OAuth scopes to grant.
+ "A String",
+ ],
+ "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
+ },
+ "serviceAccountAuthConfig": { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication.
+ "scopes": [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.
+ "A String",
+ ],
+ "serviceAccount": "A String", # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ },
+ "serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent.
+ },
+ },
+ "contextId": "A String", # Optional. If not empty, interactions with the remote A2A agent will use this context ID. This context_id field can refer to a session variable like `$context.variables.order_agent_session_id`.
+ "inputVariableMapping": { # Optional. Mapping of input variable names of remote agent to GECX variable names.
+ "a_key": "A String",
+ },
+ "outputVariableMapping": { # Optional. Mapping of output variable names of remote agent to GECX variable names.
+ "a_key": "A String",
+ },
+ "streamingEnabled": True or False, # Optional. Whether streaming is enabled for the remote agent.
+ },
+ },
"remoteDialogflowAgent": { # The agent which will transfer execution to a remote [Dialogflow CX](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent. The Dialogflow agent will process subsequent user queries until the session ends or flow ends, and the control is transferred back to the parent CES agent. # Optional. The remote [Dialogflow](https://cloud.google.com/dialogflow/cx/docs/concept/console-conversational-agents) agent to be used for the agent execution. If this field is set, all other agent level properties will be ignored. Note: If the Dialogflow agent is in a different project from the app, you should grant `roles/dialogflow.client` to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
"agent": "A String", # Required. The [Dialogflow](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent resource name. Format: `projects/{project}/locations/{location}/agents/{agent}`
"environmentId": "A String", # Optional. The environment ID of the Dialogflow agent to be used for the agent execution. If not specified, the draft environment will be used.
@@ -304,6 +376,78 @@ Method Details
"temperature": 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
},
"name": "A String", # Identifier. The unique identifier of the agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
+ "remoteA2aAgent": { # The agent which will transfer execution to a remote [A2A](https://github.com/a2aproject/A2A) agent. # Optional. The remote [A2A](https://github.com/a2aproject/A2A) agent to be used for the agent execution.
+ "a2aConfig": { # Shared configuration for connecting to a remote [A2A](https://github.com/a2aproject/A2A) agent. # Required. The A2A connection configuration.
+ "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Optional. The full agent card defined inline.
+ "description": "A String", # Required. A description of the agent's domain of action/solution space.
+ "name": "A String", # Required. A human-readable name for the agent.
+ "skills": [ # Required. Skills represent a unit of ability an agent can perform. This may somewhat abstract but represents a more focused set of actions that the agent is highly likely to succeed at.
+ { # Represents a distinct capability or function that an agent can perform.
+ "description": "A String", # Required. A detailed description of the skill.
+ "examples": [ # Example prompts or scenarios that this skill can handle.
+ "A String",
+ ],
+ "id": "A String", # Required. A unique identifier for the agent's skill.
+ "inputModes": [ # The set of supported input media types for this skill, overriding the agent's defaults.
+ "A String",
+ ],
+ "name": "A String", # Required. A human-readable name for the skill.
+ "outputModes": [ # The set of supported output media types for this skill, overriding the agent's defaults.
+ "A String",
+ ],
+ "tags": [ # Required. A set of keywords describing the skill's capabilities.
+ "A String",
+ ],
+ },
+ ],
+ "supportedInterfaces": [ # Required. Ordered list of supported interfaces. The first entry is preferred.
+ { # Declares a combination of a target URL, transport and protocol version for interacting with the agent. This allows agents to expose the same functionality over multiple protocol binding mechanisms.
+ "protocolBinding": "A String", # Required. The protocol binding supported at this URL. This is an open form string, to be easily extended for other protocol bindings. The core ones officially supported are `JSONRPC`, `GRPC` and `HTTP+JSON`.
+ "protocolVersion": "A String", # Required. The version of the A2A protocol this interface exposes. Use the latest supported minor version per major version. Examples: "0.3", "1.0"
+ "tenant": "A String", # Tenant ID to be used in the request when calling the agent.
+ "url": "A String", # Required. The URL where this interface is available. Must be a valid absolute HTTPS URL in production. Example: "https://api.example.com/a2a/v1", "https://grpc.example.com/a2a"
+ },
+ ],
+ "version": "A String", # Required. The version of the agent.
+ },
+ "agentRegistry": "A String", # Optional. Reference to the agent in the Agent Registry. Format: `projects/{project}/locations/{location}/agents/{agent}`
+ "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication configuration for calling the remote agent. Optional if the registry reference already handles authentication.
+ "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth.
+ "apiKeySecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
+ "requestLocation": "A String", # Required. Key location in the request.
+ },
+ "bearerTokenConfig": { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth.
+ "token": "A String", # Required. The bearer token. Must be in the format `$context.variables.`.
+ },
+ "oauthConfig": { # Configurations for authentication with OAuth. # Optional. Config for OAuth.
+ "clientId": "A String", # Required. The client ID from the OAuth provider.
+ "clientSecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "oauthGrantType": "A String", # Required. OAuth grant types.
+ "scopes": [ # Optional. The OAuth scopes to grant.
+ "A String",
+ ],
+ "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
+ },
+ "serviceAccountAuthConfig": { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication.
+ "scopes": [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.
+ "A String",
+ ],
+ "serviceAccount": "A String", # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ },
+ "serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent.
+ },
+ },
+ "contextId": "A String", # Optional. If not empty, interactions with the remote A2A agent will use this context ID. This context_id field can refer to a session variable like `$context.variables.order_agent_session_id`.
+ "inputVariableMapping": { # Optional. Mapping of input variable names of remote agent to GECX variable names.
+ "a_key": "A String",
+ },
+ "outputVariableMapping": { # Optional. Mapping of output variable names of remote agent to GECX variable names.
+ "a_key": "A String",
+ },
+ "streamingEnabled": True or False, # Optional. Whether streaming is enabled for the remote agent.
+ },
+ },
"remoteDialogflowAgent": { # The agent which will transfer execution to a remote [Dialogflow CX](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent. The Dialogflow agent will process subsequent user queries until the session ends or flow ends, and the control is transferred back to the parent CES agent. # Optional. The remote [Dialogflow](https://cloud.google.com/dialogflow/cx/docs/concept/console-conversational-agents) agent to be used for the agent execution. If this field is set, all other agent level properties will be ignored. Note: If the Dialogflow agent is in a different project from the app, you should grant `roles/dialogflow.client` to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
"agent": "A String", # Required. The [Dialogflow](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent resource name. Format: `projects/{project}/locations/{location}/agents/{agent}`
"environmentId": "A String", # Optional. The environment ID of the Dialogflow agent to be used for the agent execution. If not specified, the draft environment will be used.
@@ -456,6 +600,78 @@ Method Details
"temperature": 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
},
"name": "A String", # Identifier. The unique identifier of the agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
+ "remoteA2aAgent": { # The agent which will transfer execution to a remote [A2A](https://github.com/a2aproject/A2A) agent. # Optional. The remote [A2A](https://github.com/a2aproject/A2A) agent to be used for the agent execution.
+ "a2aConfig": { # Shared configuration for connecting to a remote [A2A](https://github.com/a2aproject/A2A) agent. # Required. The A2A connection configuration.
+ "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Optional. The full agent card defined inline.
+ "description": "A String", # Required. A description of the agent's domain of action/solution space.
+ "name": "A String", # Required. A human-readable name for the agent.
+ "skills": [ # Required. Skills represent a unit of ability an agent can perform. This may somewhat abstract but represents a more focused set of actions that the agent is highly likely to succeed at.
+ { # Represents a distinct capability or function that an agent can perform.
+ "description": "A String", # Required. A detailed description of the skill.
+ "examples": [ # Example prompts or scenarios that this skill can handle.
+ "A String",
+ ],
+ "id": "A String", # Required. A unique identifier for the agent's skill.
+ "inputModes": [ # The set of supported input media types for this skill, overriding the agent's defaults.
+ "A String",
+ ],
+ "name": "A String", # Required. A human-readable name for the skill.
+ "outputModes": [ # The set of supported output media types for this skill, overriding the agent's defaults.
+ "A String",
+ ],
+ "tags": [ # Required. A set of keywords describing the skill's capabilities.
+ "A String",
+ ],
+ },
+ ],
+ "supportedInterfaces": [ # Required. Ordered list of supported interfaces. The first entry is preferred.
+ { # Declares a combination of a target URL, transport and protocol version for interacting with the agent. This allows agents to expose the same functionality over multiple protocol binding mechanisms.
+ "protocolBinding": "A String", # Required. The protocol binding supported at this URL. This is an open form string, to be easily extended for other protocol bindings. The core ones officially supported are `JSONRPC`, `GRPC` and `HTTP+JSON`.
+ "protocolVersion": "A String", # Required. The version of the A2A protocol this interface exposes. Use the latest supported minor version per major version. Examples: "0.3", "1.0"
+ "tenant": "A String", # Tenant ID to be used in the request when calling the agent.
+ "url": "A String", # Required. The URL where this interface is available. Must be a valid absolute HTTPS URL in production. Example: "https://api.example.com/a2a/v1", "https://grpc.example.com/a2a"
+ },
+ ],
+ "version": "A String", # Required. The version of the agent.
+ },
+ "agentRegistry": "A String", # Optional. Reference to the agent in the Agent Registry. Format: `projects/{project}/locations/{location}/agents/{agent}`
+ "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication configuration for calling the remote agent. Optional if the registry reference already handles authentication.
+ "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth.
+ "apiKeySecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
+ "requestLocation": "A String", # Required. Key location in the request.
+ },
+ "bearerTokenConfig": { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth.
+ "token": "A String", # Required. The bearer token. Must be in the format `$context.variables.`.
+ },
+ "oauthConfig": { # Configurations for authentication with OAuth. # Optional. Config for OAuth.
+ "clientId": "A String", # Required. The client ID from the OAuth provider.
+ "clientSecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "oauthGrantType": "A String", # Required. OAuth grant types.
+ "scopes": [ # Optional. The OAuth scopes to grant.
+ "A String",
+ ],
+ "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
+ },
+ "serviceAccountAuthConfig": { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication.
+ "scopes": [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.
+ "A String",
+ ],
+ "serviceAccount": "A String", # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ },
+ "serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent.
+ },
+ },
+ "contextId": "A String", # Optional. If not empty, interactions with the remote A2A agent will use this context ID. This context_id field can refer to a session variable like `$context.variables.order_agent_session_id`.
+ "inputVariableMapping": { # Optional. Mapping of input variable names of remote agent to GECX variable names.
+ "a_key": "A String",
+ },
+ "outputVariableMapping": { # Optional. Mapping of output variable names of remote agent to GECX variable names.
+ "a_key": "A String",
+ },
+ "streamingEnabled": True or False, # Optional. Whether streaming is enabled for the remote agent.
+ },
+ },
"remoteDialogflowAgent": { # The agent which will transfer execution to a remote [Dialogflow CX](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent. The Dialogflow agent will process subsequent user queries until the session ends or flow ends, and the control is transferred back to the parent CES agent. # Optional. The remote [Dialogflow](https://cloud.google.com/dialogflow/cx/docs/concept/console-conversational-agents) agent to be used for the agent execution. If this field is set, all other agent level properties will be ignored. Note: If the Dialogflow agent is in a different project from the app, you should grant `roles/dialogflow.client` to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
"agent": "A String", # Required. The [Dialogflow](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent resource name. Format: `projects/{project}/locations/{location}/agents/{agent}`
"environmentId": "A String", # Optional. The environment ID of the Dialogflow agent to be used for the agent execution. If not specified, the draft environment will be used.
@@ -594,6 +810,78 @@ Method Details
"temperature": 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
},
"name": "A String", # Identifier. The unique identifier of the agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
+ "remoteA2aAgent": { # The agent which will transfer execution to a remote [A2A](https://github.com/a2aproject/A2A) agent. # Optional. The remote [A2A](https://github.com/a2aproject/A2A) agent to be used for the agent execution.
+ "a2aConfig": { # Shared configuration for connecting to a remote [A2A](https://github.com/a2aproject/A2A) agent. # Required. The A2A connection configuration.
+ "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Optional. The full agent card defined inline.
+ "description": "A String", # Required. A description of the agent's domain of action/solution space.
+ "name": "A String", # Required. A human-readable name for the agent.
+ "skills": [ # Required. Skills represent a unit of ability an agent can perform. This may somewhat abstract but represents a more focused set of actions that the agent is highly likely to succeed at.
+ { # Represents a distinct capability or function that an agent can perform.
+ "description": "A String", # Required. A detailed description of the skill.
+ "examples": [ # Example prompts or scenarios that this skill can handle.
+ "A String",
+ ],
+ "id": "A String", # Required. A unique identifier for the agent's skill.
+ "inputModes": [ # The set of supported input media types for this skill, overriding the agent's defaults.
+ "A String",
+ ],
+ "name": "A String", # Required. A human-readable name for the skill.
+ "outputModes": [ # The set of supported output media types for this skill, overriding the agent's defaults.
+ "A String",
+ ],
+ "tags": [ # Required. A set of keywords describing the skill's capabilities.
+ "A String",
+ ],
+ },
+ ],
+ "supportedInterfaces": [ # Required. Ordered list of supported interfaces. The first entry is preferred.
+ { # Declares a combination of a target URL, transport and protocol version for interacting with the agent. This allows agents to expose the same functionality over multiple protocol binding mechanisms.
+ "protocolBinding": "A String", # Required. The protocol binding supported at this URL. This is an open form string, to be easily extended for other protocol bindings. The core ones officially supported are `JSONRPC`, `GRPC` and `HTTP+JSON`.
+ "protocolVersion": "A String", # Required. The version of the A2A protocol this interface exposes. Use the latest supported minor version per major version. Examples: "0.3", "1.0"
+ "tenant": "A String", # Tenant ID to be used in the request when calling the agent.
+ "url": "A String", # Required. The URL where this interface is available. Must be a valid absolute HTTPS URL in production. Example: "https://api.example.com/a2a/v1", "https://grpc.example.com/a2a"
+ },
+ ],
+ "version": "A String", # Required. The version of the agent.
+ },
+ "agentRegistry": "A String", # Optional. Reference to the agent in the Agent Registry. Format: `projects/{project}/locations/{location}/agents/{agent}`
+ "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication configuration for calling the remote agent. Optional if the registry reference already handles authentication.
+ "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth.
+ "apiKeySecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
+ "requestLocation": "A String", # Required. Key location in the request.
+ },
+ "bearerTokenConfig": { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth.
+ "token": "A String", # Required. The bearer token. Must be in the format `$context.variables.`.
+ },
+ "oauthConfig": { # Configurations for authentication with OAuth. # Optional. Config for OAuth.
+ "clientId": "A String", # Required. The client ID from the OAuth provider.
+ "clientSecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "oauthGrantType": "A String", # Required. OAuth grant types.
+ "scopes": [ # Optional. The OAuth scopes to grant.
+ "A String",
+ ],
+ "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
+ },
+ "serviceAccountAuthConfig": { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication.
+ "scopes": [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.
+ "A String",
+ ],
+ "serviceAccount": "A String", # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ },
+ "serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent.
+ },
+ },
+ "contextId": "A String", # Optional. If not empty, interactions with the remote A2A agent will use this context ID. This context_id field can refer to a session variable like `$context.variables.order_agent_session_id`.
+ "inputVariableMapping": { # Optional. Mapping of input variable names of remote agent to GECX variable names.
+ "a_key": "A String",
+ },
+ "outputVariableMapping": { # Optional. Mapping of output variable names of remote agent to GECX variable names.
+ "a_key": "A String",
+ },
+ "streamingEnabled": True or False, # Optional. Whether streaming is enabled for the remote agent.
+ },
+ },
"remoteDialogflowAgent": { # The agent which will transfer execution to a remote [Dialogflow CX](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent. The Dialogflow agent will process subsequent user queries until the session ends or flow ends, and the control is transferred back to the parent CES agent. # Optional. The remote [Dialogflow](https://cloud.google.com/dialogflow/cx/docs/concept/console-conversational-agents) agent to be used for the agent execution. If this field is set, all other agent level properties will be ignored. Note: If the Dialogflow agent is in a different project from the app, you should grant `roles/dialogflow.client` to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
"agent": "A String", # Required. The [Dialogflow](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent resource name. Format: `projects/{project}/locations/{location}/agents/{agent}`
"environmentId": "A String", # Optional. The environment ID of the Dialogflow agent to be used for the agent execution. If not specified, the draft environment will be used.
@@ -738,6 +1026,78 @@ Method Details
"temperature": 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
},
"name": "A String", # Identifier. The unique identifier of the agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
+ "remoteA2aAgent": { # The agent which will transfer execution to a remote [A2A](https://github.com/a2aproject/A2A) agent. # Optional. The remote [A2A](https://github.com/a2aproject/A2A) agent to be used for the agent execution.
+ "a2aConfig": { # Shared configuration for connecting to a remote [A2A](https://github.com/a2aproject/A2A) agent. # Required. The A2A connection configuration.
+ "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Optional. The full agent card defined inline.
+ "description": "A String", # Required. A description of the agent's domain of action/solution space.
+ "name": "A String", # Required. A human-readable name for the agent.
+ "skills": [ # Required. Skills represent a unit of ability an agent can perform. This may somewhat abstract but represents a more focused set of actions that the agent is highly likely to succeed at.
+ { # Represents a distinct capability or function that an agent can perform.
+ "description": "A String", # Required. A detailed description of the skill.
+ "examples": [ # Example prompts or scenarios that this skill can handle.
+ "A String",
+ ],
+ "id": "A String", # Required. A unique identifier for the agent's skill.
+ "inputModes": [ # The set of supported input media types for this skill, overriding the agent's defaults.
+ "A String",
+ ],
+ "name": "A String", # Required. A human-readable name for the skill.
+ "outputModes": [ # The set of supported output media types for this skill, overriding the agent's defaults.
+ "A String",
+ ],
+ "tags": [ # Required. A set of keywords describing the skill's capabilities.
+ "A String",
+ ],
+ },
+ ],
+ "supportedInterfaces": [ # Required. Ordered list of supported interfaces. The first entry is preferred.
+ { # Declares a combination of a target URL, transport and protocol version for interacting with the agent. This allows agents to expose the same functionality over multiple protocol binding mechanisms.
+ "protocolBinding": "A String", # Required. The protocol binding supported at this URL. This is an open form string, to be easily extended for other protocol bindings. The core ones officially supported are `JSONRPC`, `GRPC` and `HTTP+JSON`.
+ "protocolVersion": "A String", # Required. The version of the A2A protocol this interface exposes. Use the latest supported minor version per major version. Examples: "0.3", "1.0"
+ "tenant": "A String", # Tenant ID to be used in the request when calling the agent.
+ "url": "A String", # Required. The URL where this interface is available. Must be a valid absolute HTTPS URL in production. Example: "https://api.example.com/a2a/v1", "https://grpc.example.com/a2a"
+ },
+ ],
+ "version": "A String", # Required. The version of the agent.
+ },
+ "agentRegistry": "A String", # Optional. Reference to the agent in the Agent Registry. Format: `projects/{project}/locations/{location}/agents/{agent}`
+ "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication configuration for calling the remote agent. Optional if the registry reference already handles authentication.
+ "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth.
+ "apiKeySecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
+ "requestLocation": "A String", # Required. Key location in the request.
+ },
+ "bearerTokenConfig": { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth.
+ "token": "A String", # Required. The bearer token. Must be in the format `$context.variables.`.
+ },
+ "oauthConfig": { # Configurations for authentication with OAuth. # Optional. Config for OAuth.
+ "clientId": "A String", # Required. The client ID from the OAuth provider.
+ "clientSecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "oauthGrantType": "A String", # Required. OAuth grant types.
+ "scopes": [ # Optional. The OAuth scopes to grant.
+ "A String",
+ ],
+ "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
+ },
+ "serviceAccountAuthConfig": { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication.
+ "scopes": [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.
+ "A String",
+ ],
+ "serviceAccount": "A String", # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ },
+ "serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent.
+ },
+ },
+ "contextId": "A String", # Optional. If not empty, interactions with the remote A2A agent will use this context ID. This context_id field can refer to a session variable like `$context.variables.order_agent_session_id`.
+ "inputVariableMapping": { # Optional. Mapping of input variable names of remote agent to GECX variable names.
+ "a_key": "A String",
+ },
+ "outputVariableMapping": { # Optional. Mapping of output variable names of remote agent to GECX variable names.
+ "a_key": "A String",
+ },
+ "streamingEnabled": True or False, # Optional. Whether streaming is enabled for the remote agent.
+ },
+ },
"remoteDialogflowAgent": { # The agent which will transfer execution to a remote [Dialogflow CX](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent. The Dialogflow agent will process subsequent user queries until the session ends or flow ends, and the control is transferred back to the parent CES agent. # Optional. The remote [Dialogflow](https://cloud.google.com/dialogflow/cx/docs/concept/console-conversational-agents) agent to be used for the agent execution. If this field is set, all other agent level properties will be ignored. Note: If the Dialogflow agent is in a different project from the app, you should grant `roles/dialogflow.client` to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
"agent": "A String", # Required. The [Dialogflow](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent resource name. Format: `projects/{project}/locations/{location}/agents/{agent}`
"environmentId": "A String", # Optional. The environment ID of the Dialogflow agent to be used for the agent execution. If not specified, the draft environment will be used.
@@ -864,6 +1224,78 @@ Method Details
"temperature": 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
},
"name": "A String", # Identifier. The unique identifier of the agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
+ "remoteA2aAgent": { # The agent which will transfer execution to a remote [A2A](https://github.com/a2aproject/A2A) agent. # Optional. The remote [A2A](https://github.com/a2aproject/A2A) agent to be used for the agent execution.
+ "a2aConfig": { # Shared configuration for connecting to a remote [A2A](https://github.com/a2aproject/A2A) agent. # Required. The A2A connection configuration.
+ "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Optional. The full agent card defined inline.
+ "description": "A String", # Required. A description of the agent's domain of action/solution space.
+ "name": "A String", # Required. A human-readable name for the agent.
+ "skills": [ # Required. Skills represent a unit of ability an agent can perform. This may somewhat abstract but represents a more focused set of actions that the agent is highly likely to succeed at.
+ { # Represents a distinct capability or function that an agent can perform.
+ "description": "A String", # Required. A detailed description of the skill.
+ "examples": [ # Example prompts or scenarios that this skill can handle.
+ "A String",
+ ],
+ "id": "A String", # Required. A unique identifier for the agent's skill.
+ "inputModes": [ # The set of supported input media types for this skill, overriding the agent's defaults.
+ "A String",
+ ],
+ "name": "A String", # Required. A human-readable name for the skill.
+ "outputModes": [ # The set of supported output media types for this skill, overriding the agent's defaults.
+ "A String",
+ ],
+ "tags": [ # Required. A set of keywords describing the skill's capabilities.
+ "A String",
+ ],
+ },
+ ],
+ "supportedInterfaces": [ # Required. Ordered list of supported interfaces. The first entry is preferred.
+ { # Declares a combination of a target URL, transport and protocol version for interacting with the agent. This allows agents to expose the same functionality over multiple protocol binding mechanisms.
+ "protocolBinding": "A String", # Required. The protocol binding supported at this URL. This is an open form string, to be easily extended for other protocol bindings. The core ones officially supported are `JSONRPC`, `GRPC` and `HTTP+JSON`.
+ "protocolVersion": "A String", # Required. The version of the A2A protocol this interface exposes. Use the latest supported minor version per major version. Examples: "0.3", "1.0"
+ "tenant": "A String", # Tenant ID to be used in the request when calling the agent.
+ "url": "A String", # Required. The URL where this interface is available. Must be a valid absolute HTTPS URL in production. Example: "https://api.example.com/a2a/v1", "https://grpc.example.com/a2a"
+ },
+ ],
+ "version": "A String", # Required. The version of the agent.
+ },
+ "agentRegistry": "A String", # Optional. Reference to the agent in the Agent Registry. Format: `projects/{project}/locations/{location}/agents/{agent}`
+ "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication configuration for calling the remote agent. Optional if the registry reference already handles authentication.
+ "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth.
+ "apiKeySecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
+ "requestLocation": "A String", # Required. Key location in the request.
+ },
+ "bearerTokenConfig": { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth.
+ "token": "A String", # Required. The bearer token. Must be in the format `$context.variables.`.
+ },
+ "oauthConfig": { # Configurations for authentication with OAuth. # Optional. Config for OAuth.
+ "clientId": "A String", # Required. The client ID from the OAuth provider.
+ "clientSecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "oauthGrantType": "A String", # Required. OAuth grant types.
+ "scopes": [ # Optional. The OAuth scopes to grant.
+ "A String",
+ ],
+ "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
+ },
+ "serviceAccountAuthConfig": { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication.
+ "scopes": [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.
+ "A String",
+ ],
+ "serviceAccount": "A String", # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ },
+ "serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent.
+ },
+ },
+ "contextId": "A String", # Optional. If not empty, interactions with the remote A2A agent will use this context ID. This context_id field can refer to a session variable like `$context.variables.order_agent_session_id`.
+ "inputVariableMapping": { # Optional. Mapping of input variable names of remote agent to GECX variable names.
+ "a_key": "A String",
+ },
+ "outputVariableMapping": { # Optional. Mapping of output variable names of remote agent to GECX variable names.
+ "a_key": "A String",
+ },
+ "streamingEnabled": True or False, # Optional. Whether streaming is enabled for the remote agent.
+ },
+ },
"remoteDialogflowAgent": { # The agent which will transfer execution to a remote [Dialogflow CX](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent. The Dialogflow agent will process subsequent user queries until the session ends or flow ends, and the control is transferred back to the parent CES agent. # Optional. The remote [Dialogflow](https://cloud.google.com/dialogflow/cx/docs/concept/console-conversational-agents) agent to be used for the agent execution. If this field is set, all other agent level properties will be ignored. Note: If the Dialogflow agent is in a different project from the app, you should grant `roles/dialogflow.client` to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
"agent": "A String", # Required. The [Dialogflow](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent resource name. Format: `projects/{project}/locations/{location}/agents/{agent}`
"environmentId": "A String", # Optional. The environment ID of the Dialogflow agent to be used for the agent execution. If not specified, the draft environment will be used.
diff --git a/docs/dyn/ces_v1.projects.locations.apps.conversations.html b/docs/dyn/ces_v1.projects.locations.apps.conversations.html
index 24f8253fdb..b2462c6e03 100644
--- a/docs/dyn/ces_v1.projects.locations.apps.conversations.html
+++ b/docs/dyn/ces_v1.projects.locations.apps.conversations.html
@@ -214,6 +214,7 @@ Method Details
"a_key": "", # Properties of the object.
},
"image": { # Represents an image input or output in the conversation. # Optional. Image data.
+ "altText": "A String", # Optional. The alternative text for the image.
"data": "A String", # Required. Raw bytes of the image.
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp
},
@@ -281,6 +282,7 @@ Method Details
"a_key": "", # Properties of the object.
},
"image": { # Represents an image input or output in the conversation. # Optional. Image data.
+ "altText": "A String", # Optional. The alternative text for the image.
"data": "A String", # Required. Raw bytes of the image.
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp
},
@@ -403,6 +405,7 @@ Method Details
"a_key": "", # Properties of the object.
},
"image": { # Represents an image input or output in the conversation. # Optional. Image data.
+ "altText": "A String", # Optional. The alternative text for the image.
"data": "A String", # Required. Raw bytes of the image.
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp
},
@@ -470,6 +473,7 @@ Method Details
"a_key": "", # Properties of the object.
},
"image": { # Represents an image input or output in the conversation. # Optional. Image data.
+ "altText": "A String", # Optional. The alternative text for the image.
"data": "A String", # Required. Raw bytes of the image.
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp
},
diff --git a/docs/dyn/ces_v1.projects.locations.apps.deployments.html b/docs/dyn/ces_v1.projects.locations.apps.deployments.html
index fb2fe8517f..5df3098580 100644
--- a/docs/dyn/ces_v1.projects.locations.apps.deployments.html
+++ b/docs/dyn/ces_v1.projects.locations.apps.deployments.html
@@ -119,6 +119,9 @@ Method Details
The object takes the form of:
{ # A deployment represents an immutable, queryable version of the app. It is used to deploy an app version with a specific channel profile.
+ "agentRegistryDeployment": { # Configuration and status for Agent Registry deployment. # Optional. Configuration for deploying this deployment to Agent Registry. If present, this deployment will be published to Agent Registry.
+ "agentRegistryServiceName": "A String", # Optional. Output only. The resource name of the deployed Agent Registry service. Format: `projects/{project}/locations/{location}/services/{service}`
+ },
"appVersion": "A String", # Optional. The resource name of the app version to deploy. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` Use `projects/{project}/locations/{location}/apps/{app}/versions/-` to use the draft app.
"channelProfile": { # A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony. # Required. The channel profile used in the deployment.
"channelType": "A String", # Optional. The type of the channel profile.
@@ -203,6 +206,9 @@ Method Details
An object of the form:
{ # A deployment represents an immutable, queryable version of the app. It is used to deploy an app version with a specific channel profile.
+ "agentRegistryDeployment": { # Configuration and status for Agent Registry deployment. # Optional. Configuration for deploying this deployment to Agent Registry. If present, this deployment will be published to Agent Registry.
+ "agentRegistryServiceName": "A String", # Optional. Output only. The resource name of the deployed Agent Registry service. Format: `projects/{project}/locations/{location}/services/{service}`
+ },
"appVersion": "A String", # Optional. The resource name of the app version to deploy. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` Use `projects/{project}/locations/{location}/apps/{app}/versions/-` to use the draft app.
"channelProfile": { # A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony. # Required. The channel profile used in the deployment.
"channelType": "A String", # Optional. The type of the channel profile.
@@ -312,6 +318,9 @@ Method Details
An object of the form:
{ # A deployment represents an immutable, queryable version of the app. It is used to deploy an app version with a specific channel profile.
+ "agentRegistryDeployment": { # Configuration and status for Agent Registry deployment. # Optional. Configuration for deploying this deployment to Agent Registry. If present, this deployment will be published to Agent Registry.
+ "agentRegistryServiceName": "A String", # Optional. Output only. The resource name of the deployed Agent Registry service. Format: `projects/{project}/locations/{location}/services/{service}`
+ },
"appVersion": "A String", # Optional. The resource name of the app version to deploy. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` Use `projects/{project}/locations/{location}/apps/{app}/versions/-` to use the draft app.
"channelProfile": { # A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony. # Required. The channel profile used in the deployment.
"channelType": "A String", # Optional. The type of the channel profile.
@@ -578,6 +587,9 @@ Method Details
{ # Response message for AgentService.ListDeployments.
"deployments": [ # The list of deployments.
{ # A deployment represents an immutable, queryable version of the app. It is used to deploy an app version with a specific channel profile.
+ "agentRegistryDeployment": { # Configuration and status for Agent Registry deployment. # Optional. Configuration for deploying this deployment to Agent Registry. If present, this deployment will be published to Agent Registry.
+ "agentRegistryServiceName": "A String", # Optional. Output only. The resource name of the deployed Agent Registry service. Format: `projects/{project}/locations/{location}/services/{service}`
+ },
"appVersion": "A String", # Optional. The resource name of the app version to deploy. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` Use `projects/{project}/locations/{location}/apps/{app}/versions/-` to use the draft app.
"channelProfile": { # A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony. # Required. The channel profile used in the deployment.
"channelType": "A String", # Optional. The type of the channel profile.
@@ -680,6 +692,9 @@ Method Details
The object takes the form of:
{ # A deployment represents an immutable, queryable version of the app. It is used to deploy an app version with a specific channel profile.
+ "agentRegistryDeployment": { # Configuration and status for Agent Registry deployment. # Optional. Configuration for deploying this deployment to Agent Registry. If present, this deployment will be published to Agent Registry.
+ "agentRegistryServiceName": "A String", # Optional. Output only. The resource name of the deployed Agent Registry service. Format: `projects/{project}/locations/{location}/services/{service}`
+ },
"appVersion": "A String", # Optional. The resource name of the app version to deploy. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` Use `projects/{project}/locations/{location}/apps/{app}/versions/-` to use the draft app.
"channelProfile": { # A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony. # Required. The channel profile used in the deployment.
"channelType": "A String", # Optional. The type of the channel profile.
@@ -764,6 +779,9 @@ Method Details
An object of the form:
{ # A deployment represents an immutable, queryable version of the app. It is used to deploy an app version with a specific channel profile.
+ "agentRegistryDeployment": { # Configuration and status for Agent Registry deployment. # Optional. Configuration for deploying this deployment to Agent Registry. If present, this deployment will be published to Agent Registry.
+ "agentRegistryServiceName": "A String", # Optional. Output only. The resource name of the deployed Agent Registry service. Format: `projects/{project}/locations/{location}/services/{service}`
+ },
"appVersion": "A String", # Optional. The resource name of the app version to deploy. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` Use `projects/{project}/locations/{location}/apps/{app}/versions/-` to use the draft app.
"channelProfile": { # A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony. # Required. The channel profile used in the deployment.
"channelType": "A String", # Optional. The type of the channel profile.
diff --git a/docs/dyn/ces_v1.projects.locations.apps.examples.html b/docs/dyn/ces_v1.projects.locations.apps.examples.html
index 6e52e1cd17..77425de981 100644
--- a/docs/dyn/ces_v1.projects.locations.apps.examples.html
+++ b/docs/dyn/ces_v1.projects.locations.apps.examples.html
@@ -133,6 +133,7 @@ Method Details
"a_key": "", # Properties of the object.
},
"image": { # Represents an image input or output in the conversation. # Optional. Image data.
+ "altText": "A String", # Optional. The alternative text for the image.
"data": "A String", # Required. Raw bytes of the image.
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp
},
@@ -214,6 +215,7 @@ Method Details
"a_key": "", # Properties of the object.
},
"image": { # Represents an image input or output in the conversation. # Optional. Image data.
+ "altText": "A String", # Optional. The alternative text for the image.
"data": "A String", # Required. Raw bytes of the image.
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp
},
@@ -320,6 +322,7 @@ Method Details
"a_key": "", # Properties of the object.
},
"image": { # Represents an image input or output in the conversation. # Optional. Image data.
+ "altText": "A String", # Optional. The alternative text for the image.
"data": "A String", # Required. Raw bytes of the image.
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp
},
@@ -413,6 +416,7 @@ Method Details
"a_key": "", # Properties of the object.
},
"image": { # Represents an image input or output in the conversation. # Optional. Image data.
+ "altText": "A String", # Optional. The alternative text for the image.
"data": "A String", # Required. Raw bytes of the image.
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp
},
@@ -512,6 +516,7 @@ Method Details
"a_key": "", # Properties of the object.
},
"image": { # Represents an image input or output in the conversation. # Optional. Image data.
+ "altText": "A String", # Optional. The alternative text for the image.
"data": "A String", # Required. Raw bytes of the image.
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp
},
@@ -593,6 +598,7 @@ Method Details
"a_key": "", # Properties of the object.
},
"image": { # Represents an image input or output in the conversation. # Optional. Image data.
+ "altText": "A String", # Optional. The alternative text for the image.
"data": "A String", # Required. Raw bytes of the image.
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp
},
diff --git a/docs/dyn/ces_v1.projects.locations.apps.html b/docs/dyn/ces_v1.projects.locations.apps.html
index ae1d48e758..ba0edb8d30 100644
--- a/docs/dyn/ces_v1.projects.locations.apps.html
+++ b/docs/dyn/ces_v1.projects.locations.apps.html
@@ -192,6 +192,16 @@ Method Details
"bargeInAwareness": True or False, # Optional. If enabled, the agent will adapt its next response based on the assumption that the user hasn't heard the full preceding agent message. This should not be used in scenarios where agent responses are displayed visually.
"disableBargeIn": True or False, # Optional. Deprecated: `disable_barge_in` is deprecated in favor of `disable_barge_in_control` in ChannelProfile. Disables user barge-in while the agent is speaking. If true, user input during agent response playback will be ignored.
},
+ "customVoiceSamples": [ # Optional. Configures custom voice samples for voice cloning.
+ { # Configuration for a custom voice sample used for voice cloning.
+ "consentAudioGcsUri": "A String", # Optional. Consent audio for voice cloning.
+ "name": "A String", # Optional. The user-defined name for the custom voice sample.
+ "previewAudioContent": "A String", # Output only. Synthesized preview audio for custom voice, formatted as canonical WAV (LINEAR16, 24kHz, 16-bit, mono).
+ "previewText": "A String", # Optional. Text for synthesizing preview audio for custom voice.
+ "voiceInstruction": "A String", # Optional. Natural language instructions for voice style, tone, pacing, or pronunciation.
+ "voiceSampleGcsUri": "A String", # Optional. The Cloud Storage URI to the audio sample for voice cloning. The audio sample should be a mono-channel, 24kHz WAV file.
+ },
+ ],
"inactivityTimeout": "A String", # Optional. The duration of user inactivity (no speech or interaction) before the agent prompts the user for reengagement. If not set, the agent will not prompt the user for reengagement.
"synthesizeSpeechConfigs": { # Optional. Configuration of how the agent response should be synthesized, mapping from the language code to SynthesizeSpeechConfig. If the configuration for the specified language code is not found, the configuration for the root language code will be used. For example, if the map contains "en-us" and "en", and the specified language code is "en-gb", then "en" configuration will be used. Note: Language code is case-insensitive.
"a_key": { # Configuration for how the agent response should be synthesized.
@@ -576,6 +586,15 @@ Method Details
"uri": "A String", # URI used for citation.
},
],
+ "inlineCitations": [ # Optional. List of inline citations in the agent response.
+ { # An inline citation in the response text.
+ "citedChunkIndices": [ # The indices of the cited chunks that back this text segment. Indices refer to the elements in `cited_chunks`.
+ 42,
+ ],
+ "endIndex": 42, # The ending index (in bytes) of the text segment in the agent response.
+ "startIndex": 42, # The starting index (in bytes) of the text segment in the agent response.
+ },
+ ],
},
"googleSearchSuggestions": { # Search suggestions from Google Search Tool. # The suggestions returned from Google Search as a result of invoking the Google Search Tool during the tool execution.
"htmls": [ # Compliant HTML and CSS styling for search suggestions. The provided HTML and CSS automatically adapts to your device settings, displaying in either light or dark mode indicated by `@media(prefers-color-scheme)`.
@@ -672,6 +691,16 @@ Method Details
"bargeInAwareness": True or False, # Optional. If enabled, the agent will adapt its next response based on the assumption that the user hasn't heard the full preceding agent message. This should not be used in scenarios where agent responses are displayed visually.
"disableBargeIn": True or False, # Optional. Deprecated: `disable_barge_in` is deprecated in favor of `disable_barge_in_control` in ChannelProfile. Disables user barge-in while the agent is speaking. If true, user input during agent response playback will be ignored.
},
+ "customVoiceSamples": [ # Optional. Configures custom voice samples for voice cloning.
+ { # Configuration for a custom voice sample used for voice cloning.
+ "consentAudioGcsUri": "A String", # Optional. Consent audio for voice cloning.
+ "name": "A String", # Optional. The user-defined name for the custom voice sample.
+ "previewAudioContent": "A String", # Output only. Synthesized preview audio for custom voice, formatted as canonical WAV (LINEAR16, 24kHz, 16-bit, mono).
+ "previewText": "A String", # Optional. Text for synthesizing preview audio for custom voice.
+ "voiceInstruction": "A String", # Optional. Natural language instructions for voice style, tone, pacing, or pronunciation.
+ "voiceSampleGcsUri": "A String", # Optional. The Cloud Storage URI to the audio sample for voice cloning. The audio sample should be a mono-channel, 24kHz WAV file.
+ },
+ ],
"inactivityTimeout": "A String", # Optional. The duration of user inactivity (no speech or interaction) before the agent prompts the user for reengagement. If not set, the agent will not prompt the user for reengagement.
"synthesizeSpeechConfigs": { # Optional. Configuration of how the agent response should be synthesized, mapping from the language code to SynthesizeSpeechConfig. If the configuration for the specified language code is not found, the configuration for the root language code will be used. For example, if the map contains "en-us" and "en", and the specified language code is "en-gb", then "en" configuration will be used. Note: Language code is case-insensitive.
"a_key": { # Configuration for how the agent response should be synthesized.
@@ -1183,6 +1212,16 @@ Method Details
"bargeInAwareness": True or False, # Optional. If enabled, the agent will adapt its next response based on the assumption that the user hasn't heard the full preceding agent message. This should not be used in scenarios where agent responses are displayed visually.
"disableBargeIn": True or False, # Optional. Deprecated: `disable_barge_in` is deprecated in favor of `disable_barge_in_control` in ChannelProfile. Disables user barge-in while the agent is speaking. If true, user input during agent response playback will be ignored.
},
+ "customVoiceSamples": [ # Optional. Configures custom voice samples for voice cloning.
+ { # Configuration for a custom voice sample used for voice cloning.
+ "consentAudioGcsUri": "A String", # Optional. Consent audio for voice cloning.
+ "name": "A String", # Optional. The user-defined name for the custom voice sample.
+ "previewAudioContent": "A String", # Output only. Synthesized preview audio for custom voice, formatted as canonical WAV (LINEAR16, 24kHz, 16-bit, mono).
+ "previewText": "A String", # Optional. Text for synthesizing preview audio for custom voice.
+ "voiceInstruction": "A String", # Optional. Natural language instructions for voice style, tone, pacing, or pronunciation.
+ "voiceSampleGcsUri": "A String", # Optional. The Cloud Storage URI to the audio sample for voice cloning. The audio sample should be a mono-channel, 24kHz WAV file.
+ },
+ ],
"inactivityTimeout": "A String", # Optional. The duration of user inactivity (no speech or interaction) before the agent prompts the user for reengagement. If not set, the agent will not prompt the user for reengagement.
"synthesizeSpeechConfigs": { # Optional. Configuration of how the agent response should be synthesized, mapping from the language code to SynthesizeSpeechConfig. If the configuration for the specified language code is not found, the configuration for the root language code will be used. For example, if the map contains "en-us" and "en", and the specified language code is "en-gb", then "en" configuration will be used. Note: Language code is case-insensitive.
"a_key": { # Configuration for how the agent response should be synthesized.
@@ -1480,6 +1519,16 @@ Method Details
"bargeInAwareness": True or False, # Optional. If enabled, the agent will adapt its next response based on the assumption that the user hasn't heard the full preceding agent message. This should not be used in scenarios where agent responses are displayed visually.
"disableBargeIn": True or False, # Optional. Deprecated: `disable_barge_in` is deprecated in favor of `disable_barge_in_control` in ChannelProfile. Disables user barge-in while the agent is speaking. If true, user input during agent response playback will be ignored.
},
+ "customVoiceSamples": [ # Optional. Configures custom voice samples for voice cloning.
+ { # Configuration for a custom voice sample used for voice cloning.
+ "consentAudioGcsUri": "A String", # Optional. Consent audio for voice cloning.
+ "name": "A String", # Optional. The user-defined name for the custom voice sample.
+ "previewAudioContent": "A String", # Output only. Synthesized preview audio for custom voice, formatted as canonical WAV (LINEAR16, 24kHz, 16-bit, mono).
+ "previewText": "A String", # Optional. Text for synthesizing preview audio for custom voice.
+ "voiceInstruction": "A String", # Optional. Natural language instructions for voice style, tone, pacing, or pronunciation.
+ "voiceSampleGcsUri": "A String", # Optional. The Cloud Storage URI to the audio sample for voice cloning. The audio sample should be a mono-channel, 24kHz WAV file.
+ },
+ ],
"inactivityTimeout": "A String", # Optional. The duration of user inactivity (no speech or interaction) before the agent prompts the user for reengagement. If not set, the agent will not prompt the user for reengagement.
"synthesizeSpeechConfigs": { # Optional. Configuration of how the agent response should be synthesized, mapping from the language code to SynthesizeSpeechConfig. If the configuration for the specified language code is not found, the configuration for the root language code will be used. For example, if the map contains "en-us" and "en", and the specified language code is "en-gb", then "en" configuration will be used. Note: Language code is case-insensitive.
"a_key": { # Configuration for how the agent response should be synthesized.
@@ -1756,6 +1805,16 @@ Method Details
"bargeInAwareness": True or False, # Optional. If enabled, the agent will adapt its next response based on the assumption that the user hasn't heard the full preceding agent message. This should not be used in scenarios where agent responses are displayed visually.
"disableBargeIn": True or False, # Optional. Deprecated: `disable_barge_in` is deprecated in favor of `disable_barge_in_control` in ChannelProfile. Disables user barge-in while the agent is speaking. If true, user input during agent response playback will be ignored.
},
+ "customVoiceSamples": [ # Optional. Configures custom voice samples for voice cloning.
+ { # Configuration for a custom voice sample used for voice cloning.
+ "consentAudioGcsUri": "A String", # Optional. Consent audio for voice cloning.
+ "name": "A String", # Optional. The user-defined name for the custom voice sample.
+ "previewAudioContent": "A String", # Output only. Synthesized preview audio for custom voice, formatted as canonical WAV (LINEAR16, 24kHz, 16-bit, mono).
+ "previewText": "A String", # Optional. Text for synthesizing preview audio for custom voice.
+ "voiceInstruction": "A String", # Optional. Natural language instructions for voice style, tone, pacing, or pronunciation.
+ "voiceSampleGcsUri": "A String", # Optional. The Cloud Storage URI to the audio sample for voice cloning. The audio sample should be a mono-channel, 24kHz WAV file.
+ },
+ ],
"inactivityTimeout": "A String", # Optional. The duration of user inactivity (no speech or interaction) before the agent prompts the user for reengagement. If not set, the agent will not prompt the user for reengagement.
"synthesizeSpeechConfigs": { # Optional. Configuration of how the agent response should be synthesized, mapping from the language code to SynthesizeSpeechConfig. If the configuration for the specified language code is not found, the configuration for the root language code will be used. For example, if the map contains "en-us" and "en", and the specified language code is "en-gb", then "en" configuration will be used. Note: Language code is case-insensitive.
"a_key": { # Configuration for how the agent response should be synthesized.
diff --git a/docs/dyn/ces_v1.projects.locations.apps.sessions.html b/docs/dyn/ces_v1.projects.locations.apps.sessions.html
index 78daf0ca96..b1812bcb37 100644
--- a/docs/dyn/ces_v1.projects.locations.apps.sessions.html
+++ b/docs/dyn/ces_v1.projects.locations.apps.sessions.html
@@ -152,6 +152,7 @@ Method Details
"a_key": "", # Properties of the object.
},
"image": { # Represents an image input or output in the conversation. # Optional. Image data.
+ "altText": "A String", # Optional. The alternative text for the image.
"data": "A String", # Required. Raw bytes of the image.
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp
},
@@ -232,6 +233,7 @@ Method Details
"event": "A String", # Required. The name of the event.
},
"image": { # Represents an image input or output in the conversation. # Optional. Image data from the end user.
+ "altText": "A String", # Optional. The alternative text for the image.
"data": "A String", # Required. Raw bytes of the image.
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp
},
@@ -283,6 +285,15 @@ Method Details
"uri": "A String", # URI used for citation.
},
],
+ "inlineCitations": [ # Optional. List of inline citations in the agent response.
+ { # An inline citation in the response text.
+ "citedChunkIndices": [ # The indices of the cited chunks that back this text segment. Indices refer to the elements in `cited_chunks`.
+ 42,
+ ],
+ "endIndex": 42, # The ending index (in bytes) of the text segment in the agent response.
+ "startIndex": 42, # The starting index (in bytes) of the text segment in the agent response.
+ },
+ ],
},
"context": [ # Context messages for external supervision guardrails.
{
@@ -306,6 +317,7 @@ Method Details
"a_key": "", # Properties of the object.
},
"image": { # Represents an image input or output in the conversation. # Optional. Image data.
+ "altText": "A String", # Optional. The alternative text for the image.
"data": "A String", # Required. Raw bytes of the image.
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp
},
@@ -381,12 +393,14 @@ Method Details
],
},
"image": { # Represents an image input or output in the conversation. # Output image from the CES agent.
+ "altText": "A String", # Optional. The alternative text for the image.
"data": "A String", # Required. Raw bytes of the image.
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp
},
"payload": { # Custom payload with structured output from the CES agent.
"a_key": "", # Properties of the object.
},
+ "progress": "A String", # Intermediate progress update from the CES agent.
"text": "A String", # Output text from the CES agent.
"toolCalls": { # Request for the client to execute the tools and return the execution results before continuing the session. # Request for the client to execute the tools.
"toolCalls": [ # Optional. The list of tool calls to execute.
@@ -444,6 +458,7 @@ Method Details
"a_key": "", # Properties of the object.
},
"image": { # Represents an image input or output in the conversation. # Optional. Image data.
+ "altText": "A String", # Optional. The alternative text for the image.
"data": "A String", # Required. Raw bytes of the image.
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp
},
@@ -524,6 +539,7 @@ Method Details
"event": "A String", # Required. The name of the event.
},
"image": { # Represents an image input or output in the conversation. # Optional. Image data from the end user.
+ "altText": "A String", # Optional. The alternative text for the image.
"data": "A String", # Required. Raw bytes of the image.
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp
},
@@ -575,6 +591,15 @@ Method Details
"uri": "A String", # URI used for citation.
},
],
+ "inlineCitations": [ # Optional. List of inline citations in the agent response.
+ { # An inline citation in the response text.
+ "citedChunkIndices": [ # The indices of the cited chunks that back this text segment. Indices refer to the elements in `cited_chunks`.
+ 42,
+ ],
+ "endIndex": 42, # The ending index (in bytes) of the text segment in the agent response.
+ "startIndex": 42, # The starting index (in bytes) of the text segment in the agent response.
+ },
+ ],
},
"context": [ # Context messages for external supervision guardrails.
{
@@ -598,6 +623,7 @@ Method Details
"a_key": "", # Properties of the object.
},
"image": { # Represents an image input or output in the conversation. # Optional. Image data.
+ "altText": "A String", # Optional. The alternative text for the image.
"data": "A String", # Required. Raw bytes of the image.
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp
},
@@ -673,12 +699,14 @@ Method Details
],
},
"image": { # Represents an image input or output in the conversation. # Output image from the CES agent.
+ "altText": "A String", # Optional. The alternative text for the image.
"data": "A String", # Required. Raw bytes of the image.
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp
},
"payload": { # Custom payload with structured output from the CES agent.
"a_key": "", # Properties of the object.
},
+ "progress": "A String", # Intermediate progress update from the CES agent.
"text": "A String", # Output text from the CES agent.
"toolCalls": { # Request for the client to execute the tools and return the execution results before continuing the session. # Request for the client to execute the tools.
"toolCalls": [ # Optional. The list of tool calls to execute.
diff --git a/docs/dyn/ces_v1.projects.locations.apps.versions.html b/docs/dyn/ces_v1.projects.locations.apps.versions.html
index 2610916eba..b49443796e 100644
--- a/docs/dyn/ces_v1.projects.locations.apps.versions.html
+++ b/docs/dyn/ces_v1.projects.locations.apps.versions.html
@@ -100,6 +100,9 @@ Instance Methods
list_next(previous_request, previous_response)
Retrieves the next page of results.
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
+Updates the specified app version.
restore(name, body=None, x__xgafv=None)
Restores the specified app version. This will create a new app version from the current draft app and overwrite the current draft with the specified app version.
@@ -195,6 +198,78 @@ Method Details
"temperature": 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
},
"name": "A String", # Identifier. The unique identifier of the agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
+ "remoteA2aAgent": { # The agent which will transfer execution to a remote [A2A](https://github.com/a2aproject/A2A) agent. # Optional. The remote [A2A](https://github.com/a2aproject/A2A) agent to be used for the agent execution.
+ "a2aConfig": { # Shared configuration for connecting to a remote [A2A](https://github.com/a2aproject/A2A) agent. # Required. The A2A connection configuration.
+ "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Optional. The full agent card defined inline.
+ "description": "A String", # Required. A description of the agent's domain of action/solution space.
+ "name": "A String", # Required. A human-readable name for the agent.
+ "skills": [ # Required. Skills represent a unit of ability an agent can perform. This may somewhat abstract but represents a more focused set of actions that the agent is highly likely to succeed at.
+ { # Represents a distinct capability or function that an agent can perform.
+ "description": "A String", # Required. A detailed description of the skill.
+ "examples": [ # Example prompts or scenarios that this skill can handle.
+ "A String",
+ ],
+ "id": "A String", # Required. A unique identifier for the agent's skill.
+ "inputModes": [ # The set of supported input media types for this skill, overriding the agent's defaults.
+ "A String",
+ ],
+ "name": "A String", # Required. A human-readable name for the skill.
+ "outputModes": [ # The set of supported output media types for this skill, overriding the agent's defaults.
+ "A String",
+ ],
+ "tags": [ # Required. A set of keywords describing the skill's capabilities.
+ "A String",
+ ],
+ },
+ ],
+ "supportedInterfaces": [ # Required. Ordered list of supported interfaces. The first entry is preferred.
+ { # Declares a combination of a target URL, transport and protocol version for interacting with the agent. This allows agents to expose the same functionality over multiple protocol binding mechanisms.
+ "protocolBinding": "A String", # Required. The protocol binding supported at this URL. This is an open form string, to be easily extended for other protocol bindings. The core ones officially supported are `JSONRPC`, `GRPC` and `HTTP+JSON`.
+ "protocolVersion": "A String", # Required. The version of the A2A protocol this interface exposes. Use the latest supported minor version per major version. Examples: "0.3", "1.0"
+ "tenant": "A String", # Tenant ID to be used in the request when calling the agent.
+ "url": "A String", # Required. The URL where this interface is available. Must be a valid absolute HTTPS URL in production. Example: "https://api.example.com/a2a/v1", "https://grpc.example.com/a2a"
+ },
+ ],
+ "version": "A String", # Required. The version of the agent.
+ },
+ "agentRegistry": "A String", # Optional. Reference to the agent in the Agent Registry. Format: `projects/{project}/locations/{location}/agents/{agent}`
+ "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication configuration for calling the remote agent. Optional if the registry reference already handles authentication.
+ "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth.
+ "apiKeySecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
+ "requestLocation": "A String", # Required. Key location in the request.
+ },
+ "bearerTokenConfig": { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth.
+ "token": "A String", # Required. The bearer token. Must be in the format `$context.variables.`.
+ },
+ "oauthConfig": { # Configurations for authentication with OAuth. # Optional. Config for OAuth.
+ "clientId": "A String", # Required. The client ID from the OAuth provider.
+ "clientSecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "oauthGrantType": "A String", # Required. OAuth grant types.
+ "scopes": [ # Optional. The OAuth scopes to grant.
+ "A String",
+ ],
+ "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
+ },
+ "serviceAccountAuthConfig": { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication.
+ "scopes": [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.
+ "A String",
+ ],
+ "serviceAccount": "A String", # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ },
+ "serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent.
+ },
+ },
+ "contextId": "A String", # Optional. If not empty, interactions with the remote A2A agent will use this context ID. This context_id field can refer to a session variable like `$context.variables.order_agent_session_id`.
+ "inputVariableMapping": { # Optional. Mapping of input variable names of remote agent to GECX variable names.
+ "a_key": "A String",
+ },
+ "outputVariableMapping": { # Optional. Mapping of output variable names of remote agent to GECX variable names.
+ "a_key": "A String",
+ },
+ "streamingEnabled": True or False, # Optional. Whether streaming is enabled for the remote agent.
+ },
+ },
"remoteDialogflowAgent": { # The agent which will transfer execution to a remote [Dialogflow CX](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent. The Dialogflow agent will process subsequent user queries until the session ends or flow ends, and the control is transferred back to the parent CES agent. # Optional. The remote [Dialogflow](https://cloud.google.com/dialogflow/cx/docs/concept/console-conversational-agents) agent to be used for the agent execution. If this field is set, all other agent level properties will be ignored. Note: If the Dialogflow agent is in a different project from the app, you should grant `roles/dialogflow.client` to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
"agent": "A String", # Required. The [Dialogflow](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent resource name. Format: `projects/{project}/locations/{location}/agents/{agent}`
"environmentId": "A String", # Optional. The environment ID of the Dialogflow agent to be used for the agent execution. If not specified, the draft environment will be used.
@@ -256,6 +331,16 @@ Method Details
"bargeInAwareness": True or False, # Optional. If enabled, the agent will adapt its next response based on the assumption that the user hasn't heard the full preceding agent message. This should not be used in scenarios where agent responses are displayed visually.
"disableBargeIn": True or False, # Optional. Deprecated: `disable_barge_in` is deprecated in favor of `disable_barge_in_control` in ChannelProfile. Disables user barge-in while the agent is speaking. If true, user input during agent response playback will be ignored.
},
+ "customVoiceSamples": [ # Optional. Configures custom voice samples for voice cloning.
+ { # Configuration for a custom voice sample used for voice cloning.
+ "consentAudioGcsUri": "A String", # Optional. Consent audio for voice cloning.
+ "name": "A String", # Optional. The user-defined name for the custom voice sample.
+ "previewAudioContent": "A String", # Output only. Synthesized preview audio for custom voice, formatted as canonical WAV (LINEAR16, 24kHz, 16-bit, mono).
+ "previewText": "A String", # Optional. Text for synthesizing preview audio for custom voice.
+ "voiceInstruction": "A String", # Optional. Natural language instructions for voice style, tone, pacing, or pronunciation.
+ "voiceSampleGcsUri": "A String", # Optional. The Cloud Storage URI to the audio sample for voice cloning. The audio sample should be a mono-channel, 24kHz WAV file.
+ },
+ ],
"inactivityTimeout": "A String", # Optional. The duration of user inactivity (no speech or interaction) before the agent prompts the user for reengagement. If not set, the agent will not prompt the user for reengagement.
"synthesizeSpeechConfigs": { # Optional. Configuration of how the agent response should be synthesized, mapping from the language code to SynthesizeSpeechConfig. If the configuration for the specified language code is not found, the configuration for the root language code will be used. For example, if the map contains "en-us" and "en", and the specified language code is "en-gb", then "en" configuration will be used. Note: Language code is case-insensitive.
"a_key": { # Configuration for how the agent response should be synthesized.
@@ -534,6 +619,7 @@ Method Details
"a_key": "", # Properties of the object.
},
"image": { # Represents an image input or output in the conversation. # Optional. Image data.
+ "altText": "A String", # Optional. The alternative text for the image.
"data": "A String", # Required. Raw bytes of the image.
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp
},
@@ -1433,6 +1519,7 @@ Method Details
},
],
},
+ "updateTime": "A String", # Output only. Timestamp when the app version was last updated.
}
appVersionId: string, Optional. The ID to use for the app version, which will become the final component of the app version's resource name. If not provided, a unique ID will be automatically assigned for the app version.
@@ -1521,6 +1608,78 @@ Method Details
"temperature": 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
},
"name": "A String", # Identifier. The unique identifier of the agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
+ "remoteA2aAgent": { # The agent which will transfer execution to a remote [A2A](https://github.com/a2aproject/A2A) agent. # Optional. The remote [A2A](https://github.com/a2aproject/A2A) agent to be used for the agent execution.
+ "a2aConfig": { # Shared configuration for connecting to a remote [A2A](https://github.com/a2aproject/A2A) agent. # Required. The A2A connection configuration.
+ "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Optional. The full agent card defined inline.
+ "description": "A String", # Required. A description of the agent's domain of action/solution space.
+ "name": "A String", # Required. A human-readable name for the agent.
+ "skills": [ # Required. Skills represent a unit of ability an agent can perform. This may somewhat abstract but represents a more focused set of actions that the agent is highly likely to succeed at.
+ { # Represents a distinct capability or function that an agent can perform.
+ "description": "A String", # Required. A detailed description of the skill.
+ "examples": [ # Example prompts or scenarios that this skill can handle.
+ "A String",
+ ],
+ "id": "A String", # Required. A unique identifier for the agent's skill.
+ "inputModes": [ # The set of supported input media types for this skill, overriding the agent's defaults.
+ "A String",
+ ],
+ "name": "A String", # Required. A human-readable name for the skill.
+ "outputModes": [ # The set of supported output media types for this skill, overriding the agent's defaults.
+ "A String",
+ ],
+ "tags": [ # Required. A set of keywords describing the skill's capabilities.
+ "A String",
+ ],
+ },
+ ],
+ "supportedInterfaces": [ # Required. Ordered list of supported interfaces. The first entry is preferred.
+ { # Declares a combination of a target URL, transport and protocol version for interacting with the agent. This allows agents to expose the same functionality over multiple protocol binding mechanisms.
+ "protocolBinding": "A String", # Required. The protocol binding supported at this URL. This is an open form string, to be easily extended for other protocol bindings. The core ones officially supported are `JSONRPC`, `GRPC` and `HTTP+JSON`.
+ "protocolVersion": "A String", # Required. The version of the A2A protocol this interface exposes. Use the latest supported minor version per major version. Examples: "0.3", "1.0"
+ "tenant": "A String", # Tenant ID to be used in the request when calling the agent.
+ "url": "A String", # Required. The URL where this interface is available. Must be a valid absolute HTTPS URL in production. Example: "https://api.example.com/a2a/v1", "https://grpc.example.com/a2a"
+ },
+ ],
+ "version": "A String", # Required. The version of the agent.
+ },
+ "agentRegistry": "A String", # Optional. Reference to the agent in the Agent Registry. Format: `projects/{project}/locations/{location}/agents/{agent}`
+ "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication configuration for calling the remote agent. Optional if the registry reference already handles authentication.
+ "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth.
+ "apiKeySecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
+ "requestLocation": "A String", # Required. Key location in the request.
+ },
+ "bearerTokenConfig": { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth.
+ "token": "A String", # Required. The bearer token. Must be in the format `$context.variables.`.
+ },
+ "oauthConfig": { # Configurations for authentication with OAuth. # Optional. Config for OAuth.
+ "clientId": "A String", # Required. The client ID from the OAuth provider.
+ "clientSecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "oauthGrantType": "A String", # Required. OAuth grant types.
+ "scopes": [ # Optional. The OAuth scopes to grant.
+ "A String",
+ ],
+ "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
+ },
+ "serviceAccountAuthConfig": { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication.
+ "scopes": [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.
+ "A String",
+ ],
+ "serviceAccount": "A String", # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ },
+ "serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent.
+ },
+ },
+ "contextId": "A String", # Optional. If not empty, interactions with the remote A2A agent will use this context ID. This context_id field can refer to a session variable like `$context.variables.order_agent_session_id`.
+ "inputVariableMapping": { # Optional. Mapping of input variable names of remote agent to GECX variable names.
+ "a_key": "A String",
+ },
+ "outputVariableMapping": { # Optional. Mapping of output variable names of remote agent to GECX variable names.
+ "a_key": "A String",
+ },
+ "streamingEnabled": True or False, # Optional. Whether streaming is enabled for the remote agent.
+ },
+ },
"remoteDialogflowAgent": { # The agent which will transfer execution to a remote [Dialogflow CX](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent. The Dialogflow agent will process subsequent user queries until the session ends or flow ends, and the control is transferred back to the parent CES agent. # Optional. The remote [Dialogflow](https://cloud.google.com/dialogflow/cx/docs/concept/console-conversational-agents) agent to be used for the agent execution. If this field is set, all other agent level properties will be ignored. Note: If the Dialogflow agent is in a different project from the app, you should grant `roles/dialogflow.client` to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
"agent": "A String", # Required. The [Dialogflow](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent resource name. Format: `projects/{project}/locations/{location}/agents/{agent}`
"environmentId": "A String", # Optional. The environment ID of the Dialogflow agent to be used for the agent execution. If not specified, the draft environment will be used.
@@ -1582,6 +1741,16 @@ Method Details
"bargeInAwareness": True or False, # Optional. If enabled, the agent will adapt its next response based on the assumption that the user hasn't heard the full preceding agent message. This should not be used in scenarios where agent responses are displayed visually.
"disableBargeIn": True or False, # Optional. Deprecated: `disable_barge_in` is deprecated in favor of `disable_barge_in_control` in ChannelProfile. Disables user barge-in while the agent is speaking. If true, user input during agent response playback will be ignored.
},
+ "customVoiceSamples": [ # Optional. Configures custom voice samples for voice cloning.
+ { # Configuration for a custom voice sample used for voice cloning.
+ "consentAudioGcsUri": "A String", # Optional. Consent audio for voice cloning.
+ "name": "A String", # Optional. The user-defined name for the custom voice sample.
+ "previewAudioContent": "A String", # Output only. Synthesized preview audio for custom voice, formatted as canonical WAV (LINEAR16, 24kHz, 16-bit, mono).
+ "previewText": "A String", # Optional. Text for synthesizing preview audio for custom voice.
+ "voiceInstruction": "A String", # Optional. Natural language instructions for voice style, tone, pacing, or pronunciation.
+ "voiceSampleGcsUri": "A String", # Optional. The Cloud Storage URI to the audio sample for voice cloning. The audio sample should be a mono-channel, 24kHz WAV file.
+ },
+ ],
"inactivityTimeout": "A String", # Optional. The duration of user inactivity (no speech or interaction) before the agent prompts the user for reengagement. If not set, the agent will not prompt the user for reengagement.
"synthesizeSpeechConfigs": { # Optional. Configuration of how the agent response should be synthesized, mapping from the language code to SynthesizeSpeechConfig. If the configuration for the specified language code is not found, the configuration for the root language code will be used. For example, if the map contains "en-us" and "en", and the specified language code is "en-gb", then "en" configuration will be used. Note: Language code is case-insensitive.
"a_key": { # Configuration for how the agent response should be synthesized.
@@ -1860,6 +2029,7 @@ Method Details
"a_key": "", # Properties of the object.
},
"image": { # Represents an image input or output in the conversation. # Optional. Image data.
+ "altText": "A String", # Optional. The alternative text for the image.
"data": "A String", # Required. Raw bytes of the image.
"mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp
},
@@ -2759,6 +2929,7 @@ Method Details
},
],
},
+ "updateTime": "A String", # Output only. Timestamp when the app version was last updated.
}
patch(name, body=None, updateMask=None, x__xgafv=None)
+ Updates the specified app version.
+
+Args:
+ name: string, Identifier. The unique identifier of the app version. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # In Customer Engagement Suite (CES), an app version is a snapshot of the app at a specific point in time. It is immutable and cannot be modified once created.
+ "createTime": "A String", # Output only. Timestamp when the app version was created.
+ "creator": "A String", # Output only. Email of the user who created the app version.
+ "description": "A String", # Optional. The description of the app version.
+ "displayName": "A String", # Optional. The display name of the app version.
+ "etag": "A String", # Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
+ "name": "A String", # Identifier. The unique identifier of the app version. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`
+ "snapshot": { # A snapshot of the app. # Output only. The snapshot of the app when the version is created.
+ "agents": [ # Optional. List of agents in the app.
+ { # An agent acts as the fundamental building block that provides instructions to the Large Language Model (LLM) for executing specific tasks.
+ "afterAgentCallbacks": [ # Optional. The callbacks to execute after the agent is called. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.
+ { # A callback defines the custom logic to be executed at various stages of agent interaction.
+ "description": "A String", # Optional. Human-readable description of the callback.
+ "disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
+ "pythonCode": "A String", # Required. The python code to execute for the callback.
+ },
+ ],
+ "afterModelCallbacks": [ # Optional. The callbacks to execute after the model is called. If there are multiple calls to the model, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.
+ { # A callback defines the custom logic to be executed at various stages of agent interaction.
+ "description": "A String", # Optional. Human-readable description of the callback.
+ "disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
+ "pythonCode": "A String", # Required. The python code to execute for the callback.
+ },
+ ],
+ "afterToolCallbacks": [ # Optional. The callbacks to execute after the tool is invoked. If there are multiple tool invocations, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.
+ { # A callback defines the custom logic to be executed at various stages of agent interaction.
+ "description": "A String", # Optional. Human-readable description of the callback.
+ "disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
+ "pythonCode": "A String", # Required. The python code to execute for the callback.
+ },
+ ],
+ "beforeAgentCallbacks": [ # Optional. The callbacks to execute before the agent is called. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.
+ { # A callback defines the custom logic to be executed at various stages of agent interaction.
+ "description": "A String", # Optional. Human-readable description of the callback.
+ "disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
+ "pythonCode": "A String", # Required. The python code to execute for the callback.
+ },
+ ],
+ "beforeModelCallbacks": [ # Optional. The callbacks to execute before the model is called. If there are multiple calls to the model, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.
+ { # A callback defines the custom logic to be executed at various stages of agent interaction.
+ "description": "A String", # Optional. Human-readable description of the callback.
+ "disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
+ "pythonCode": "A String", # Required. The python code to execute for the callback.
+ },
+ ],
+ "beforeToolCallbacks": [ # Optional. The callbacks to execute before the tool is invoked. If there are multiple tool invocations, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.
+ { # A callback defines the custom logic to be executed at various stages of agent interaction.
+ "description": "A String", # Optional. Human-readable description of the callback.
+ "disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
+ "pythonCode": "A String", # Required. The python code to execute for the callback.
+ },
+ ],
+ "childAgents": [ # Optional. List of child agents in the agent tree. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
+ "A String",
+ ],
+ "createTime": "A String", # Output only. Timestamp when the agent was created.
+ "description": "A String", # Optional. Human-readable description of the agent.
+ "displayName": "A String", # Required. Display name of the agent.
+ "etag": "A String", # Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
+ "generatedSummary": "A String", # Output only. If the agent is generated by the LLM assistant, this field contains a descriptive summary of the generation.
+ "guardrails": [ # Optional. List of guardrails for the agent. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`
+ "A String",
+ ],
+ "instruction": "A String", # Optional. Instructions for the LLM model to guide the agent's behavior.
+ "llmAgent": { # Default agent type. The agent uses instructions and callbacks specified in the agent to perform the task using a large language model. # Optional. The default agent type.
+ },
+ "modelSettings": { # Model settings contains various configurations for the LLM model. # Optional. Configurations for the LLM model.
+ "model": "A String", # Optional. The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
+ "temperature": 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
+ },
+ "name": "A String", # Identifier. The unique identifier of the agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
+ "remoteA2aAgent": { # The agent which will transfer execution to a remote [A2A](https://github.com/a2aproject/A2A) agent. # Optional. The remote [A2A](https://github.com/a2aproject/A2A) agent to be used for the agent execution.
+ "a2aConfig": { # Shared configuration for connecting to a remote [A2A](https://github.com/a2aproject/A2A) agent. # Required. The A2A connection configuration.
+ "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Optional. The full agent card defined inline.
+ "description": "A String", # Required. A description of the agent's domain of action/solution space.
+ "name": "A String", # Required. A human-readable name for the agent.
+ "skills": [ # Required. Skills represent a unit of ability an agent can perform. This may somewhat abstract but represents a more focused set of actions that the agent is highly likely to succeed at.
+ { # Represents a distinct capability or function that an agent can perform.
+ "description": "A String", # Required. A detailed description of the skill.
+ "examples": [ # Example prompts or scenarios that this skill can handle.
+ "A String",
+ ],
+ "id": "A String", # Required. A unique identifier for the agent's skill.
+ "inputModes": [ # The set of supported input media types for this skill, overriding the agent's defaults.
+ "A String",
+ ],
+ "name": "A String", # Required. A human-readable name for the skill.
+ "outputModes": [ # The set of supported output media types for this skill, overriding the agent's defaults.
+ "A String",
+ ],
+ "tags": [ # Required. A set of keywords describing the skill's capabilities.
+ "A String",
+ ],
+ },
+ ],
+ "supportedInterfaces": [ # Required. Ordered list of supported interfaces. The first entry is preferred.
+ { # Declares a combination of a target URL, transport and protocol version for interacting with the agent. This allows agents to expose the same functionality over multiple protocol binding mechanisms.
+ "protocolBinding": "A String", # Required. The protocol binding supported at this URL. This is an open form string, to be easily extended for other protocol bindings. The core ones officially supported are `JSONRPC`, `GRPC` and `HTTP+JSON`.
+ "protocolVersion": "A String", # Required. The version of the A2A protocol this interface exposes. Use the latest supported minor version per major version. Examples: "0.3", "1.0"
+ "tenant": "A String", # Tenant ID to be used in the request when calling the agent.
+ "url": "A String", # Required. The URL where this interface is available. Must be a valid absolute HTTPS URL in production. Example: "https://api.example.com/a2a/v1", "https://grpc.example.com/a2a"
+ },
+ ],
+ "version": "A String", # Required. The version of the agent.
+ },
+ "agentRegistry": "A String", # Optional. Reference to the agent in the Agent Registry. Format: `projects/{project}/locations/{location}/agents/{agent}`
+ "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication configuration for calling the remote agent. Optional if the registry reference already handles authentication.
+ "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth.
+ "apiKeySecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
+ "requestLocation": "A String", # Required. Key location in the request.
+ },
+ "bearerTokenConfig": { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth.
+ "token": "A String", # Required. The bearer token. Must be in the format `$context.variables.`.
+ },
+ "oauthConfig": { # Configurations for authentication with OAuth. # Optional. Config for OAuth.
+ "clientId": "A String", # Required. The client ID from the OAuth provider.
+ "clientSecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "oauthGrantType": "A String", # Required. OAuth grant types.
+ "scopes": [ # Optional. The OAuth scopes to grant.
+ "A String",
+ ],
+ "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
+ },
+ "serviceAccountAuthConfig": { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication.
+ "scopes": [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.
+ "A String",
+ ],
+ "serviceAccount": "A String", # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ },
+ "serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent.
+ },
+ },
+ "contextId": "A String", # Optional. If not empty, interactions with the remote A2A agent will use this context ID. This context_id field can refer to a session variable like `$context.variables.order_agent_session_id`.
+ "inputVariableMapping": { # Optional. Mapping of input variable names of remote agent to GECX variable names.
+ "a_key": "A String",
+ },
+ "outputVariableMapping": { # Optional. Mapping of output variable names of remote agent to GECX variable names.
+ "a_key": "A String",
+ },
+ "streamingEnabled": True or False, # Optional. Whether streaming is enabled for the remote agent.
+ },
+ },
+ "remoteDialogflowAgent": { # The agent which will transfer execution to a remote [Dialogflow CX](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent. The Dialogflow agent will process subsequent user queries until the session ends or flow ends, and the control is transferred back to the parent CES agent. # Optional. The remote [Dialogflow](https://cloud.google.com/dialogflow/cx/docs/concept/console-conversational-agents) agent to be used for the agent execution. If this field is set, all other agent level properties will be ignored. Note: If the Dialogflow agent is in a different project from the app, you should grant `roles/dialogflow.client` to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "agent": "A String", # Required. The [Dialogflow](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent resource name. Format: `projects/{project}/locations/{location}/agents/{agent}`
+ "environmentId": "A String", # Optional. The environment ID of the Dialogflow agent to be used for the agent execution. If not specified, the draft environment will be used.
+ "flowId": "A String", # Optional. The flow ID of the flow in the Dialogflow agent.
+ "inputVariableMapping": { # Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input.
+ "a_key": "A String",
+ },
+ "languageCodeVariable": "A String", # Optional. The name of the variable that contains the language code to be used for the Dialogflow session. If unspecified, the default language code of the Dialogflow agent will be used.
+ "outputVariableMapping": { # Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends.
+ "a_key": "A String",
+ },
+ "respectResponseInterruptionSettings": True or False, # Optional. Indicates whether to respect the message-level interruption settings configured in the Dialogflow agent. * If false: all response messages from the Dialogflow agent follow the app-level barge-in settings. * If true: only response messages with [`allow_playback_interruption`](https://docs.cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#text) set to true will be interruptable, all other messages follow the app-level barge-in settings.
+ },
+ "tools": [ # Optional. List of available tools for the agent. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
+ "A String",
+ ],
+ "toolsets": [ # Optional. List of toolsets for the agent.
+ { # A toolset with a selection of its tools.
+ "toolIds": [ # Optional. The tools IDs to filter the toolset.
+ "A String",
+ ],
+ "toolset": "A String", # Required. The resource name of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
+ },
+ ],
+ "transferRules": [ # Optional. Agent transfer rules. If multiple rules match, the first one in the list will be used.
+ { # Rule for transferring to a specific agent.
+ "childAgent": "A String", # Required. The resource name of the child agent the rule applies to. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
+ "deterministicTransfer": { # Deterministic transfer rule. When the condition evaluates to true, the transfer occurs. # Optional. A rule that immediately transfers to the target agent when the condition is met.
+ "expressionCondition": { # Expression condition based on session state. # Optional. A rule that evaluates a session state condition. If the condition evaluates to true, the transfer occurs.
+ "expression": "A String", # Required. The string representation of cloud.api.Expression condition.
+ },
+ "pythonCodeCondition": { # Python code block to evaluate the condition. # Optional. A rule that uses Python code block to evaluate the conditions. If the condition evaluates to true, the transfer occurs.
+ "pythonCode": "A String", # Required. The python code to execute.
+ },
+ },
+ "direction": "A String", # Required. The direction of the transfer.
+ "disablePlannerTransfer": { # A rule that prevents the planner from transferring to the target agent. # Optional. Rule that prevents the planner from transferring to the target agent.
+ "expressionCondition": { # Expression condition based on session state. # Required. If the condition evaluates to true, planner will not be allowed to transfer to the target agent.
+ "expression": "A String", # Required. The string representation of cloud.api.Expression condition.
+ },
+ },
+ },
+ ],
+ "updateTime": "A String", # Output only. Timestamp when the agent was last updated.
+ "validationErrors": [ # Output only. Misconfigurations or errors in the agent that may affect agent quality.
+ "A String",
+ ],
+ },
+ ],
+ "app": { # An app serves as a top-level container for a group of agents, including the root agent and its sub-agents, along with their associated configurations. These agents work together to achieve specific goals within the app's context. # Optional. The basic settings for the app.
+ "audioProcessingConfig": { # Configuration for how the input and output audio should be processed and delivered. # Optional. Audio processing configuration of the app.
+ "ambientSoundConfig": { # Configuration for the ambient sound to be played with the synthesized agent response, to enhance the naturalness of the conversation. # Optional. Configuration for the ambient sound to be played with the synthesized agent response, to enhance the naturalness of the conversation.
+ "gcsUri": "A String", # Optional. Ambient noise as a mono-channel, 16kHz WAV file stored in [Cloud Storage](https://cloud.google.com/storage). Note: Please make sure the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com` has `storage.objects.get` permission to the Cloud Storage object.
+ "prebuiltAmbientNoise": "A String", # Optional. Deprecated: `prebuilt_ambient_noise` is deprecated in favor of `prebuilt_ambient_sound`.
+ "prebuiltAmbientSound": "A String", # Optional. Name of the prebuilt ambient sound. Valid values are: - "coffee_shop" - "keyboard" - "keypad" - "hum" - "office_1" - "office_2" - "office_3" - "room_1" - "room_2" - "room_3" - "room_4" - "room_5" - "air_conditioner"
+ "volumeGainDb": 3.14, # Optional. Volume gain (in dB) of the normal native volume supported by ambient noise, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.
+ },
+ "bargeInConfig": { # Configuration for how the user barge-in activities should be handled. # Optional. Configures the agent behavior for the user barge-in activities.
+ "bargeInAwareness": True or False, # Optional. If enabled, the agent will adapt its next response based on the assumption that the user hasn't heard the full preceding agent message. This should not be used in scenarios where agent responses are displayed visually.
+ "disableBargeIn": True or False, # Optional. Deprecated: `disable_barge_in` is deprecated in favor of `disable_barge_in_control` in ChannelProfile. Disables user barge-in while the agent is speaking. If true, user input during agent response playback will be ignored.
+ },
+ "customVoiceSamples": [ # Optional. Configures custom voice samples for voice cloning.
+ { # Configuration for a custom voice sample used for voice cloning.
+ "consentAudioGcsUri": "A String", # Optional. Consent audio for voice cloning.
+ "name": "A String", # Optional. The user-defined name for the custom voice sample.
+ "previewAudioContent": "A String", # Output only. Synthesized preview audio for custom voice, formatted as canonical WAV (LINEAR16, 24kHz, 16-bit, mono).
+ "previewText": "A String", # Optional. Text for synthesizing preview audio for custom voice.
+ "voiceInstruction": "A String", # Optional. Natural language instructions for voice style, tone, pacing, or pronunciation.
+ "voiceSampleGcsUri": "A String", # Optional. The Cloud Storage URI to the audio sample for voice cloning. The audio sample should be a mono-channel, 24kHz WAV file.
+ },
+ ],
+ "inactivityTimeout": "A String", # Optional. The duration of user inactivity (no speech or interaction) before the agent prompts the user for reengagement. If not set, the agent will not prompt the user for reengagement.
+ "synthesizeSpeechConfigs": { # Optional. Configuration of how the agent response should be synthesized, mapping from the language code to SynthesizeSpeechConfig. If the configuration for the specified language code is not found, the configuration for the root language code will be used. For example, if the map contains "en-us" and "en", and the specified language code is "en-gb", then "en" configuration will be used. Note: Language code is case-insensitive.
+ "a_key": { # Configuration for how the agent response should be synthesized.
+ "consentAudioGcsUri": "A String", # Optional. Deprecated: Use `custom_voice_samples` in AudioProcessingConfig instead. The Cloud Storage URI to the consent audio for voice cloning.
+ "instruction": "A String", # Optional. The instruction used to synthesize speech when using a generative model.
+ "model": "A String", # Optional. The model used to synthesize audio. Currently supported values: - "gemini-3.1-flash-tts-preview" If empty, Chirp3-HD is used.
+ "speakingRate": 3.14, # Optional. The speaking rate/speed in the range [0.25, 2.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. Values outside of the range [0.25, 2.0] will return an error.
+ "voice": "A String", # Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices) from Cloud Text-to-Speech.
+ "voiceSampleGcsUri": "A String", # Optional. Deprecated: Use `custom_voice_samples` in AudioProcessingConfig instead. The Cloud Storage URI to the audio sample for voice cloning. The audio sample should be a mono-channel, 24kHz WAV file. Note: Please make sure the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com` has `storage.objects.get` permission to the Cloud Storage object.
+ },
+ },
+ },
+ "clientCertificateSettings": { # Settings for custom client certificates. # Optional. The default client certificate settings for the app.
+ "passphrase": "A String", # Optional. The name of the SecretManager secret version resource storing the passphrase to decrypt the private key. Should be left unset if the private key is not encrypted. Format: `projects/{project}/secrets/{secret}/versions/{version}`
+ "privateKey": "A String", # Required. The name of the SecretManager secret version resource storing the private key encoded in PEM format. Format: `projects/{project}/secrets/{secret}/versions/{version}`
+ "tlsCertificate": "A String", # Required. The TLS certificate encoded in PEM format. This string must include the begin header and end footer lines.
+ },
+ "createTime": "A String", # Output only. Timestamp when the app was created.
+ "dashboardSettings": { # Settings for dashboards associated with the app, that show up in the Monitoring view. # Optional. App-specific dashboard settings for linking and configuring Contact Center Insights dashboards.
+ "defaultDashboard": "A String", # Optional. The resource name of the default Contact Center Insights dashboard associated with the app. This is the dashboard that will be displayed when users navigate to the Monitoring view for the app. Format: `projects/{project}/locations/{location}/dashboards/{dashboard}`
+ },
+ "dataStoreSettings": { # Data store related settings for the app. # Optional. The data store settings for the app.
+ "engines": [ # Output only. The engines for the app.
+ { # An engine to which the data stores are connected. See Vertex AI Search: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction.
+ "name": "A String", # Output only. The resource name of the engine. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
+ "type": "A String", # Output only. The type of the engine.
+ },
+ ],
+ },
+ "defaultChannelProfile": { # A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony. # Optional. The default channel profile used by the app.
+ "channelType": "A String", # Optional. The type of the channel profile.
+ "disableBargeInControl": True or False, # Optional. Whether to disable user barge-in control in the conversation. - **true**: User interruptions are disabled while the agent is speaking. - **false**: The agent retains automatic control over when the user can interrupt.
+ "disableDtmf": True or False, # Optional. Whether to disable DTMF (dual-tone multi-frequency).
+ "instagramConfig": { # Configuration specific to Instagram deployments. # Optional. Configuration specific to Instagram deployments.
+ "description": "A String", # Output only. The description of the Meta business page or profile.
+ "displayName": "A String", # Output only. The fetched Meta business page name.
+ "instagramAccountId": "A String", # Required. The Instagram Account ID.
+ "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL.
+ },
+ "noiseSuppressionLevel": "A String", # Optional. The noise suppression level of the channel profile. Available values are "low", "moderate", "high", "very_high".
+ "personaProperty": { # Represents the persona property of a channel. # Optional. The persona property of the channel profile.
+ "persona": "A String", # Optional. The persona of the channel.
+ },
+ "profileId": "A String", # Optional. The unique identifier of the channel profile.
+ "webWidgetConfig": { # Message for configuration for the web widget. # Optional. The configuration for the web widget.
+ "modality": "A String", # Optional. The modality of the web widget.
+ "securitySettings": { # Security settings for the web widget. # Optional. The security settings of the web widget.
+ "allowedOrigins": [ # Optional. The origins that are allowed to host the web widget. An origin is defined by RFC 6454. If empty, all origins are allowed. A maximum of 100 origins is allowed. Example: "https://example.com"
+ "A String",
+ ],
+ "enableOriginCheck": True or False, # Optional. Indicates whether origin check for the web widget is enabled. If `true`, the web widget will check the origin of the website that loads the web widget and only allow it to be loaded in the same origin or any of the allowed origins.
+ "enablePublicAccess": True or False, # Optional. Indicates whether public access to the web widget is enabled. If `true`, the web widget will be publicly accessible. If `false`, the web widget must be integrated with your own authentication and authorization system to return valid credentials for accessing the CES agent.
+ "enableRecaptcha": True or False, # Optional. Indicates whether reCAPTCHA verification for the web widget is enabled.
+ },
+ "theme": "A String", # Optional. The theme of the web widget.
+ "webWidgetTitle": "A String", # Optional. The title of the web widget.
+ },
+ "whatsappConfig": { # Configuration specific to WhatsApp deployments. # Optional. Configuration specific to WhatsApp deployments.
+ "description": "A String", # Output only. The description of the Meta business page or profile.
+ "displayName": "A String", # Output only. The fetched Meta business page name.
+ "phoneNumber": "A String", # Optional. The phone number in E.164 format.
+ "phoneNumberId": "A String", # Required. The Meta phone number ID.
+ "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL.
+ "wabaId": "A String", # Required. The WhatsApp Business Account ID.
+ },
+ },
+ "deploymentCount": 42, # Output only. Number of deployments in the app.
+ "description": "A String", # Optional. Human-readable description of the app.
+ "displayName": "A String", # Required. Display name of the app.
+ "errorHandlingSettings": { # Settings to describe how errors should be handled in the app. # Optional. Error handling settings of the app.
+ "endSessionConfig": { # Configuration for ending the session in case of system errors (e.g. LLM errors). # Optional. Configuration for ending the session in case of system errors (e.g. LLM errors).
+ "escalateSession": True or False, # Optional. Whether to escalate the session in EndSession. If session is escalated, metadata in EndSession will contain `session_escalated = true`. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/deploy/google-telephony-platform#transfer_a_call_to_a_human_agent for details.
+ },
+ "errorHandlingStrategy": "A String", # Optional. The strategy to use for error handling.
+ "fallbackResponseConfig": { # Configuration for handling fallback responses. # Optional. Configuration for handling fallback responses.
+ "customFallbackMessages": { # Optional. The fallback messages in case of system errors (e.g. LLM errors), mapped by [supported language code](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/reference/language).
+ "a_key": "A String",
+ },
+ "maxFallbackAttempts": 42, # Optional. The maximum number of fallback attempts to make before the agent emitting EndSession Signal.
+ },
+ },
+ "etag": "A String", # Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
+ "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Optional. The evaluation thresholds for the app.
+ "goldenEvaluationMetricsThresholds": { # Settings for golden evaluations. # Optional. The golden evaluation metrics thresholds.
+ "expectationLevelMetricsThresholds": { # Expectation level metrics thresholds. # Optional. The expectation level metrics thresholds.
+ "toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0.
+ },
+ "toolMatchingSettings": { # Settings for matching tool calls. # Optional. The tool matching settings. An extra tool call is a tool call that is present in the execution but does not match any tool call in the golden expectation.
+ "extraToolCallBehavior": "A String", # Optional. Behavior for extra tool calls. Defaults to FAIL.
+ },
+ "turnLevelMetricsThresholds": { # Turn level metrics thresholds. # Optional. The turn level metrics thresholds.
+ "overallToolInvocationCorrectnessThreshold": 3.14, # Optional. The success threshold for overall tool invocation correctness. Must be a float between 0 and 1. Default is 1.0.
+ "semanticSimilarityChannel": "A String", # Optional. The semantic similarity channel to use for evaluation.
+ "semanticSimilaritySuccessThreshold": 42, # Optional. The success threshold for semantic similarity. Must be an integer between 0 and 4. Default is >= 3.
+ },
+ },
+ "goldenHallucinationMetricBehavior": "A String", # Optional. The hallucination metric behavior for golden evaluations.
+ "hallucinationMetricBehavior": "A String", # Optional. Deprecated: Use `golden_hallucination_metric_behavior` instead. The hallucination metric behavior is currently used for golden evaluations.
+ "scenarioHallucinationMetricBehavior": "A String", # Optional. The hallucination metric behavior for scenario evaluations.
+ },
+ "globalInstruction": "A String", # Optional. Instructions for all the agents in the app. You can use this instruction to set up a stable identity or personality across all the agents.
+ "guardrails": [ # Optional. List of guardrails for the app. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`
+ "A String",
+ ],
+ "languageSettings": { # Language settings of the app. # Optional. Language settings of the app.
+ "defaultLanguageCode": "A String", # Optional. The default language code of the app.
+ "enableMultilingualSupport": True or False, # Optional. Enables multilingual support. If true, agents in the app will use pre-built instructions to improve handling of multilingual input.
+ "fallbackAction": "A String", # Optional. Deprecated: This feature is no longer supported. Use `enable_multilingual_support` instead to improve handling of multilingual input. The action to perform when an agent receives input in an unsupported language. This can be a predefined action or a custom tool call. Valid values are: - A tool's full resource name, which triggers a specific tool execution. - A predefined system action, such as "escalate" or "exit", which triggers an EndSession signal with corresponding metadata to terminate the conversation.
+ "supportedLanguageCodes": [ # Optional. List of languages codes supported by the app, in addition to the `default_language_code`.
+ "A String",
+ ],
+ },
+ "locked": True or False, # Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected.
+ "loggingSettings": { # Settings to describe the logging behaviors for the app. # Optional. Logging settings of the app.
+ "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. The audio is subject to redaction as configured in RedactionConfig.
+ "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used.
+ },
+ "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The conversation data is subject to redaction as configured in RedactionConfig.
+ "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to.
+ "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled.
+ "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ },
+ "cloudLoggingSettings": { # Settings to describe the Cloud Logging behaviors for the app. # Optional. Settings to describe the Cloud Logging behaviors for the app.
+ "enableCloudLogging": True or False, # Optional. Whether to enable Cloud Logging for the sessions.
+ },
+ "conversationLoggingSettings": { # Settings to describe the conversation logging behaviors for the app. # Optional. Settings to describe the conversation logging behaviors for the app.
+ "disableConversationLogging": True or False, # Optional. Whether to disable conversation logging for the sessions.
+ "retentionWindow": "A String", # Optional. Controls the retention window for the conversation. If not set, the conversation will be retained for 365 days.
+ },
+ "evaluationAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded for the evaluation. By default, audio recording is not enabled for evaluation sessions.
+ "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used.
+ },
+ "metricAnalysisSettings": { # Settings to describe the conversation data collection behaviors for LLM analysis metrics pipeline. # Optional. Settings to describe the conversation data collection behaviors for the LLM analysis pipeline for the app.
+ "llmMetricsOptedOut": True or False, # Optional. Whether to collect conversation data for llm analysis metrics. If true, conversation data will not be collected for llm analysis metrics; otherwise, conversation data will be collected.
+ },
+ "redactionConfig": { # Configuration to instruct how sensitive data should be handled. # Optional. Configuration for how sensitive data should be redacted.
+ "deidentifyTemplate": "A String", # Optional. [DLP](https://cloud.google.com/dlp/docs) deidentify template name to instruct on how to de-identify content. Format: `projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template}`
+ "enableRedaction": True or False, # Optional. If true, redaction will be applied in various logging scenarios, including conversation history, Cloud Logging and audio recording.
+ "inspectTemplate": "A String", # Optional. [DLP](https://cloud.google.com/dlp/docs) inspect template name to configure detection of sensitive data types. Format: `projects/{project}/locations/{location}/inspectTemplates/{inspect_template}`
+ },
+ "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures an additional recording of unredacted audio. This can be used to maintain a raw audio copy when audio redaction is enabled, typically for auditing or monitoring purposes.
+ "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used.
+ },
+ "unredactedBigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The unredacted conversation data will be exported to BigQuery tables if it is enabled.
+ "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to.
+ "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled.
+ "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ },
+ },
+ "metadata": { # Optional. Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages.
+ "a_key": "A String",
+ },
+ "modelSettings": { # Model settings contains various configurations for the LLM model. # Optional. The default LLM model settings for the app. Individual resources (e.g. agents, guardrails) can override these configurations as needed.
+ "model": "A String", # Optional. The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
+ "temperature": 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
+ },
+ "name": "A String", # Identifier. The unique identifier of the app. Format: `projects/{project}/locations/{location}/apps/{app}`
+ "pinned": True or False, # Optional. Whether the app is pinned in the app list.
+ "predefinedVariableDeclarations": [ # Output only. The declarations of predefined variables for the app.
+ { # Defines the structure and metadata for a variable.
+ "description": "A String", # Required. The description of the variable.
+ "name": "A String", # Required. The name of the variable. The name must start with a letter or underscore and contain only letters, numbers, or underscores.
+ "schema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Required. The schema of the variable.
+ "additionalProperties": # Object with schema name: Schema # 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: Schema
+ ],
+ "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: Schema
+ },
+ "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",
+ ],
+ "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
+ "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+ "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
+ "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+ "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
+ "nullable": True or False, # Optional. Indicates if the value may be null.
+ "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY.
+ # Object with schema name: Schema
+ ],
+ "properties": { # Optional. Properties of Type.OBJECT.
+ "a_key": # Object with schema name: Schema
+ },
+ "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", # Required. The type of the data.
+ "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
+ },
+ },
+ ],
+ "rootAgent": "A String", # Optional. The root agent is the entry point of the app. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
+ "timeZoneSettings": { # TimeZone settings of the app. # Optional. TimeZone settings of the app.
+ "timeZone": "A String", # Optional. The time zone of the app from the [time zone database](https://www.iana.org/time-zones), e.g., America/Los_Angeles, Europe/Paris.
+ },
+ "toolExecutionMode": "A String", # Optional. The tool execution mode for the app. If not provided, will default to PARALLEL.
+ "updateTime": "A String", # Output only. Timestamp when the app was last updated.
+ "validationErrors": [ # Output only. Misconfigurations or warnings in the app.
+ "A String",
+ ],
+ "variableDeclarations": [ # Optional. The declarations of the variables.
+ { # Defines the structure and metadata for a variable.
+ "description": "A String", # Required. The description of the variable.
+ "name": "A String", # Required. The name of the variable. The name must start with a letter or underscore and contain only letters, numbers, or underscores.
+ "schema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Required. The schema of the variable.
+ "additionalProperties": # Object with schema name: Schema # 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: Schema
+ ],
+ "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: Schema
+ },
+ "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",
+ ],
+ "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
+ "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+ "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
+ "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+ "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
+ "nullable": True or False, # Optional. Indicates if the value may be null.
+ "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY.
+ # Object with schema name: Schema
+ ],
+ "properties": { # Optional. Properties of Type.OBJECT.
+ "a_key": # Object with schema name: Schema
+ },
+ "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", # Required. The type of the data.
+ "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
+ },
+ },
+ ],
+ "vpcScSettings": { # VPC-SC settings for the app. # Optional. VPC-SC settings for the app.
+ "allowedOrigins": [ # Optional. The allowed HTTP(s) origins that OpenAPI tools in the App are able to directly call when VPC Service Controls are enabled. These strings must match the origin exactly, including the port if specified. For example, "https://example.com" or "https://example.com:443". This list does not yet apply to Python tools that may make direct HTTP calls.
+ "A String",
+ ],
+ },
+ },
+ "examples": [ # Optional. List of examples in the app.
+ { # An example represents a sample conversation between the user and the agent(s).
+ "createTime": "A String", # Output only. Timestamp when the example was created.
+ "description": "A String", # Optional. Human-readable description of the example.
+ "displayName": "A String", # Required. Display name of the example.
+ "entryAgent": "A String", # Optional. The agent that initially handles the conversation. If not specified, the example represents a conversation that is handled by the root agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
+ "etag": "A String", # Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
+ "invalid": True or False, # Output only. The example may become invalid if referencing resources are deleted. Invalid examples will not be used as few-shot examples.
+ "messages": [ # Optional. The collection of messages that make up the conversation.
+ { # A message within a conversation.
+ "chunks": [ # Optional. Content of the message as a series of chunks.
+ { # A chunk of content within a message.
+ "agentTransfer": { # Represents an event indicating the transfer of a conversation to a different agent. # Optional. Agent transfer event.
+ "displayName": "A String", # Output only. Display name of the agent.
+ "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
+ },
+ "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data.
+ "data": "A String", # Required. Raw bytes of the blob.
+ "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+ },
+ "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names.
+ "a_key": "", # Properties of the object.
+ },
+ "image": { # Represents an image input or output in the conversation. # Optional. Image data.
+ "altText": "A String", # Optional. The alternative text for the image.
+ "data": "A String", # Required. Raw bytes of the image.
+ "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp
+ },
+ "payload": { # Optional. Custom payload data.
+ "a_key": "", # Properties of the object.
+ },
+ "text": "A String", # Optional. Text data.
+ "toolCall": { # Request for the client or the agent to execute the specified tool. # Optional. Tool execution request.
+ "agentName": "A String", # Output only. Human-readable name of the agent that issued this call, e.g. "Contract Architect". Empty when the root agent issued it.
+ "args": { # Optional. The input parameters and values for the tool in JSON object format.
+ "a_key": "", # Properties of the object.
+ },
+ "displayName": "A String", # Output only. Display name of the tool.
+ "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse.
+ "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling.
+ "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
+ "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute.
+ "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for.
+ "toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
+ },
+ },
+ "toolResponse": { # The execution result of a specific tool from the client or the agent. # Optional. Tool execution response.
+ "agentName": "A String", # Output only. Human-readable name of the agent that issued this call, e.g. "Contract Architect". Empty when the root agent issued it.
+ "displayName": "A String", # Output only. Display name of the tool.
+ "id": "A String", # Optional. The matching ID of the tool call the response is for.
+ "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling.
+ "response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result.
+ "a_key": "", # Properties of the object.
+ },
+ "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
+ "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed.
+ "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for.
+ "toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
+ },
+ },
+ "transcript": "A String", # Optional. Transcript associated with the audio.
+ "updatedVariables": { # A struct represents variables that were updated in the conversation, keyed by variable names.
+ "a_key": "", # Properties of the object.
+ },
+ },
+ ],
+ "eventTime": "A String", # Optional. Timestamp when the message was sent or received. Should not be used if the message is part of an example.
+ "role": "A String", # Optional. The role within the conversation, e.g., user, agent.
+ },
+ ],
+ "name": "A String", # Identifier. The unique identifier of the example. Format: `projects/{project}/locations/{location}/apps/{app}/examples/{example}`
+ "updateTime": "A String", # Output only. Timestamp when the example was last updated.
+ },
+ ],
+ "guardrails": [ # Optional. List of guardrails in the app.
+ { # Guardrail contains a list of checks and balances to keep the agents safe and secure.
+ "action": { # Action that is taken when a certain precondition is met. # Optional. Action to take when the guardrail is triggered.
+ "generativeAnswer": { # The agent will immediately respond with a generative answer. # Optional. Respond with a generative answer.
+ "prompt": "A String", # Required. The prompt to use for the generative answer.
+ },
+ "respondImmediately": { # The agent will immediately respond with a preconfigured response. # Optional. Immediately respond with a preconfigured response.
+ "responses": [ # Required. The canned responses for the agent to choose from. The response is chosen randomly.
+ { # Represents a response from the agent.
+ "disabled": True or False, # Optional. Whether the response is disabled. Disabled responses are not used by the agent.
+ "text": "A String", # Required. Text for the agent to respond with.
+ },
+ ],
+ },
+ "transferAgent": { # The agent will transfer the conversation to a different agent. # Optional. Transfer the conversation to a different agent.
+ "agent": "A String", # Required. The name of the agent to transfer the conversation to. The agent must be in the same app as the current agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
+ },
+ },
+ "codeCallback": { # Guardrail that blocks the conversation based on the code callbacks provided. # Optional. Guardrail that potentially blocks the conversation based on the result of the callback execution.
+ "afterAgentCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute after the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
+ "description": "A String", # Optional. Human-readable description of the callback.
+ "disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
+ "pythonCode": "A String", # Required. The python code to execute for the callback.
+ },
+ "afterModelCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute after the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
+ "description": "A String", # Optional. Human-readable description of the callback.
+ "disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
+ "pythonCode": "A String", # Required. The python code to execute for the callback.
+ },
+ "beforeAgentCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute before the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
+ "description": "A String", # Optional. Human-readable description of the callback.
+ "disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
+ "pythonCode": "A String", # Required. The python code to execute for the callback.
+ },
+ "beforeModelCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute before the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
+ "description": "A String", # Optional. Human-readable description of the callback.
+ "disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
+ "pythonCode": "A String", # Required. The python code to execute for the callback.
+ },
+ },
+ "contentFilter": { # Guardrail that bans certain content from being used in the conversation. # Optional. Guardrail that bans certain content from being used in the conversation.
+ "bannedContents": [ # Optional. List of banned phrases. Applies to both user inputs and agent responses.
+ "A String",
+ ],
+ "bannedContentsInAgentResponse": [ # Optional. List of banned phrases. Applies only to agent responses.
+ "A String",
+ ],
+ "bannedContentsInUserInput": [ # Optional. List of banned phrases. Applies only to user inputs.
+ "A String",
+ ],
+ "disregardDiacritics": True or False, # Optional. If true, diacritics are ignored during matching.
+ "matchType": "A String", # Required. Match type for the content filter.
+ },
+ "createTime": "A String", # Output only. Timestamp when the guardrail was created.
+ "description": "A String", # Optional. Description of the guardrail.
+ "displayName": "A String", # Required. Display name of the guardrail.
+ "enabled": True or False, # Optional. Whether the guardrail is enabled.
+ "etag": "A String", # Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
+ "llmPolicy": { # Guardrail that blocks the conversation if the LLM response is considered violating the policy based on the LLM classification. # Optional. Guardrail that blocks the conversation if the LLM response is considered violating the policy based on the LLM classification.
+ "allowShortUtterance": True or False, # Optional. By default, the LLM policy check is bypassed for short utterances. Enabling this setting applies the policy check to all utterances, including those that would normally be skipped.
+ "failOpen": True or False, # Optional. If an error occurs during the policy check, fail open and do not trigger the guardrail.
+ "maxConversationMessages": 42, # Optional. When checking this policy, consider the last 'n' messages in the conversation. When not set a default value of 10 will be used.
+ "modelSettings": { # Model settings contains various configurations for the LLM model. # Optional. Model settings.
+ "model": "A String", # Optional. The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
+ "temperature": 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
+ },
+ "policyScope": "A String", # Required. Defines when to apply the policy check during the conversation. If set to `POLICY_SCOPE_UNSPECIFIED`, the policy will be applied to the user input. When applying the policy to the agent response, additional latency will be introduced before the agent can respond.
+ "prompt": "A String", # Required. Policy prompt.
+ },
+ "llmPromptSecurity": { # Guardrail that blocks the conversation if the input is considered unsafe based on the LLM classification. # Optional. Guardrail that blocks the conversation if the prompt is considered unsafe based on the LLM classification.
+ "customPolicy": { # Guardrail that blocks the conversation if the LLM response is considered violating the policy based on the LLM classification. # Optional. Use a user-defined LlmPolicy to configure the security guardrail.
+ "allowShortUtterance": True or False, # Optional. By default, the LLM policy check is bypassed for short utterances. Enabling this setting applies the policy check to all utterances, including those that would normally be skipped.
+ "failOpen": True or False, # Optional. If an error occurs during the policy check, fail open and do not trigger the guardrail.
+ "maxConversationMessages": 42, # Optional. When checking this policy, consider the last 'n' messages in the conversation. When not set a default value of 10 will be used.
+ "modelSettings": { # Model settings contains various configurations for the LLM model. # Optional. Model settings.
+ "model": "A String", # Optional. The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
+ "temperature": 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
+ },
+ "policyScope": "A String", # Required. Defines when to apply the policy check during the conversation. If set to `POLICY_SCOPE_UNSPECIFIED`, the policy will be applied to the user input. When applying the policy to the agent response, additional latency will be introduced before the agent can respond.
+ "prompt": "A String", # Required. Policy prompt.
+ },
+ "defaultSettings": { # Configuration for default system security settings. # Optional. Use the system's predefined default security settings. To select this mode, include an empty 'default_settings' message in the request. The 'default_prompt_template' field within will be populated by the server in the response.
+ "defaultPromptTemplate": "A String", # Output only. The default prompt template used by the system. This field is for display purposes to show the user what prompt the system uses by default. It is OUTPUT_ONLY.
+ },
+ "failOpen": True or False, # Optional. Determines the behavior when the guardrail encounters an LLM error. - If true: the guardrail is bypassed. - If false (default): the guardrail triggers/blocks. Note: If a custom policy is provided, this field is ignored in favor of the policy's 'fail_open' configuration.
+ },
+ "modelSafety": { # Model safety settings overrides. When this is set, it will override the default settings and trigger the guardrail if the response is considered unsafe. # Optional. Guardrail that blocks the conversation if the LLM response is considered unsafe based on the model safety settings.
+ "safetySettings": [ # Required. List of safety settings.
+ { # Safety setting.
+ "category": "A String", # Required. The harm category.
+ "threshold": "A String", # Required. The harm block threshold.
+ },
+ ],
+ },
+ "name": "A String", # Identifier. The unique identifier of the guardrail. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`
+ "updateTime": "A String", # Output only. Timestamp when the guardrail was last updated.
+ },
+ ],
+ "tools": [ # Optional. List of tools in the app.
+ { # A tool represents an action that the CES agent can take to achieve certain goals.
+ "agentTool": { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool.
+ "agent": "A String", # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}`
+ "description": "A String", # Optional. Description of the tool's purpose.
+ "name": "A String", # Required. The name of the agent tool.
+ },
+ "clientFunction": { # Represents a client-side function that the agent can invoke. When the tool is chosen by the agent, control is handed off to the client. The client is responsible for executing the function and returning the result as a ToolResponse to continue the interaction with the agent. # Optional. The client function.
+ "description": "A String", # Optional. The function description.
+ "name": "A String", # Required. The function name.
+ "parameters": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the function parameters.
+ "additionalProperties": # Object with schema name: Schema # 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: Schema
+ ],
+ "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: Schema
+ },
+ "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",
+ ],
+ "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
+ "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+ "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
+ "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+ "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
+ "nullable": True or False, # Optional. Indicates if the value may be null.
+ "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY.
+ # Object with schema name: Schema
+ ],
+ "properties": { # Optional. Properties of Type.OBJECT.
+ "a_key": # Object with schema name: Schema
+ },
+ "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", # Required. The type of the data.
+ "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
+ },
+ "response": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the function response.
+ "additionalProperties": # Object with schema name: Schema # 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: Schema
+ ],
+ "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: Schema
+ },
+ "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",
+ ],
+ "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
+ "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+ "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
+ "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+ "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
+ "nullable": True or False, # Optional. Indicates if the value may be null.
+ "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY.
+ # Object with schema name: Schema
+ ],
+ "properties": { # Optional. Properties of Type.OBJECT.
+ "a_key": # Object with schema name: Schema
+ },
+ "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", # Required. The type of the data.
+ "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
+ },
+ },
+ "connectorTool": { # A ConnectorTool allows connections to different integrations. See: https://cloud.google.com/integration-connectors/docs/overview. # Optional. The Integration Connector tool.
+ "action": { # Configuration of an Action for the tool to use. Note: This can be either an Action or an Operation. See https://cloud.google.com/integration-connectors/docs/entities-operation-action for details. # Required. Action for the tool to use.
+ "connectionActionId": "A String", # ID of a Connection action for the tool to use.
+ "entityOperation": { # Entity CRUD operation specification. # Entity operation configuration for the tool to use.
+ "entityId": "A String", # Required. ID of the entity.
+ "operation": "A String", # Required. Operation to perform on the entity.
+ },
+ "inputFields": [ # Optional. Entity fields to use as inputs for the operation. If no fields are specified, all fields of the Entity will be used.
+ "A String",
+ ],
+ "outputFields": [ # Optional. Entity fields to return from the operation. If no fields are specified, all fields of the Entity will be returned.
+ "A String",
+ ],
+ },
+ "authConfig": { # End-user authentication configuration used for Connection calls. The field values must be the names of context variables in the format `$context.variables.`. # Optional. Configures how authentication is handled in Integration Connectors. By default, an admin authentication is passed in the Integration Connectors API requests. You can override it with a different end-user authentication config. **Note**: The Connection must have authentication override enabled in order to specify an EUC configuration here - otherwise, the ConnectorTool creation will fail. See https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override for details.
+ "oauth2AuthCodeConfig": { # Oauth 2.0 Authorization Code authentication configuration. # Oauth 2.0 Authorization Code authentication.
+ "oauthToken": "A String", # Required. Oauth token parameter name to pass through. Must be in the format `$context.variables.`.
+ },
+ "oauth2JwtBearerConfig": { # JWT Profile Oauth 2.0 Authorization Grant authentication configuration. # JWT Profile Oauth 2.0 Authorization Grant authentication.
+ "clientKey": "A String", # Required. Client parameter name to pass through. Must be in the format `$context.variables.`.
+ "issuer": "A String", # Required. Issuer parameter name to pass through. Must be in the format `$context.variables.`.
+ "subject": "A String", # Required. Subject parameter name to pass through. Must be in the format `$context.variables.`.
+ },
+ },
+ "connection": "A String", # Required. The full resource name of the referenced Integration Connectors Connection. Format: `projects/{project}/locations/{location}/connections/{connection}`
+ "description": "A String", # Optional. The description of the tool that can be used by the Agent to decide whether to call this ConnectorTool.
+ "name": "A String", # Optional. The name of the tool that can be used by the Agent to decide whether to call this ConnectorTool.
+ },
+ "createTime": "A String", # Output only. Timestamp when the tool was created.
+ "dataStoreTool": { # Tool to retrieve from Vertex AI Search datastore or engine for grounding. Accepts either a datastore or an engine, but not both. See Vertex AI Search: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction. # Optional. The data store tool.
+ "boostSpecs": [ # Optional. Boost specification to boost certain documents.
+ { # Boost specifications to boost certain documents. For more information, please refer to https://cloud.google.com/generative-ai-app-builder/docs/boosting.
+ "dataStores": [ # Required. The Data Store where the boosting configuration is applied. Full resource name of DataStore, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}.
+ "A String",
+ ],
+ "spec": [ # Required. A list of boosting specifications.
+ { # Boost specification to boost certain documents.
+ "conditionBoostSpecs": [ # Required. A list of boosting specifications.
+ { # Boost specification for a condition.
+ "boost": 3.14, # Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the suggestions a big promotion. However, it does not necessarily mean that the top result will be a boosted suggestion. Setting to -1.0 gives the suggestions a big demotion. However, other suggestions that are relevant might still be shown. Setting to 0.0 means no boost applied. The boosting condition is ignored.
+ "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Optional. Complex specification for custom ranking based on customer defined attribute value.
+ "attributeType": "A String", # Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).
+ "controlPoints": [ # Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.
+ { # The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).
+ "attributeValue": "A String", # Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.
+ "boostAmount": 3.14, # Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
+ },
+ ],
+ "fieldName": "A String", # Optional. The name of the field whose value will be used to determine the boost amount.
+ "interpolationType": "A String", # Optional. The interpolation type to be applied to connect the control points listed below.
+ },
+ "condition": "A String", # Required. An expression which specifies a boost condition. The syntax is the same as filter expression syntax. Currently, the only supported condition is a list of BCP-47 lang codes. Example: To boost suggestions in languages en or fr: (lang_code: ANY("en", "fr"))
+ },
+ ],
+ },
+ ],
+ },
+ ],
+ "dataStoreSource": { # Configuration for searching within a specific DataStore. # Optional. Search within a single specific DataStore.
+ "dataStore": { # A DataStore resource in Vertex AI Search. # Optional. The data store.
+ "connectorConfig": { # The connector config for the data store connection. # Output only. The connector config for the data store connection.
+ "collection": "A String", # Resource name of the collection the data store belongs to.
+ "collectionDisplayName": "A String", # Display name of the collection the data store belongs to.
+ "dataSource": "A String", # The name of the data source. Example: `salesforce`, `jira`, `confluence`, `bigquery`.
+ },
+ "createTime": "A String", # Output only. Timestamp when the data store was created.
+ "displayName": "A String", # Output only. The display name of the data store.
+ "documentProcessingMode": "A String", # Output only. The document processing mode for the data store connection. Only set for PUBLIC_WEB and UNSTRUCTURED data stores.
+ "name": "A String", # Required. Full resource name of the DataStore. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
+ "type": "A String", # Output only. The type of the data store. This field is readonly and populated by the server.
+ },
+ "filter": "A String", # Optional. Filter specification for the DataStore. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
+ },
+ "description": "A String", # Optional. The tool description.
+ "engineSource": { # Configuration for searching within an Engine, potentially targeting specific DataStores. # Optional. Search within an Engine (potentially across multiple DataStores).
+ "dataStoreSources": [ # Optional. Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine.
+ { # Configuration for searching within a specific DataStore.
+ "dataStore": { # A DataStore resource in Vertex AI Search. # Optional. The data store.
+ "connectorConfig": { # The connector config for the data store connection. # Output only. The connector config for the data store connection.
+ "collection": "A String", # Resource name of the collection the data store belongs to.
+ "collectionDisplayName": "A String", # Display name of the collection the data store belongs to.
+ "dataSource": "A String", # The name of the data source. Example: `salesforce`, `jira`, `confluence`, `bigquery`.
+ },
+ "createTime": "A String", # Output only. Timestamp when the data store was created.
+ "displayName": "A String", # Output only. The display name of the data store.
+ "documentProcessingMode": "A String", # Output only. The document processing mode for the data store connection. Only set for PUBLIC_WEB and UNSTRUCTURED data stores.
+ "name": "A String", # Required. Full resource name of the DataStore. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
+ "type": "A String", # Output only. The type of the data store. This field is readonly and populated by the server.
+ },
+ "filter": "A String", # Optional. Filter specification for the DataStore. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
+ },
+ ],
+ "engine": "A String", # Required. Full resource name of the Engine. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
+ "filter": "A String", # Optional. A filter applied to the search across the Engine. Not relevant and not used if 'data_store_sources' is provided. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
+ },
+ "filterParameterBehavior": "A String", # Optional. The filter parameter behavior.
+ "modalityConfigs": [ # Optional. The modality configs for the data store.
+ { # If specified, will apply the given configuration for the specified modality.
+ "groundingConfig": { # Grounding configuration. # Optional. The grounding configuration.
+ "disabled": True or False, # Optional. Whether grounding is disabled.
+ "groundingLevel": 3.14, # Optional. The groundedness threshold of the answer based on the retrieved sources. The value has a configurable range of [1, 5]. The level is used to threshold the groundedness of the answer, meaning that all responses with a groundedness score below the threshold will fall back to returning relevant snippets only. For example, a level of 3 means that the groundedness score must be 3 or higher for the response to be returned.
+ },
+ "modalityType": "A String", # Required. The modality type.
+ "rewriterConfig": { # Rewriter configuration. # Optional. The rewriter config.
+ "disabled": True or False, # Optional. Whether the rewriter is disabled.
+ "modelSettings": { # Model settings contains various configurations for the LLM model. # Required. Configurations for the LLM model.
+ "model": "A String", # Optional. The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
+ "temperature": 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
+ },
+ "prompt": "A String", # Optional. The prompt definition. If not set, default prompt will be used.
+ },
+ "snippetsConfig": { # Snippets configuration. # Optional. The snippets configuration.
+ "enableSnippets": True or False, # Optional. Whether snippets are enabled.
+ "maxSnippets": 42, # Optional. Number of snippets to return per query. If unset, returns all snippets from the service by default.
+ },
+ "summarizationConfig": { # Summarization configuration. # Optional. The summarization config.
+ "disabled": True or False, # Optional. Whether summarization is disabled.
+ "modelSettings": { # Model settings contains various configurations for the LLM model. # Optional. Configurations for the LLM model.
+ "model": "A String", # Optional. The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
+ "temperature": 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
+ },
+ "prompt": "A String", # Optional. The prompt definition. If not set, default prompt will be used.
+ },
+ },
+ ],
+ "name": "A String", # Required. The data store tool name.
+ },
+ "displayName": "A String", # Output only. The display name of the tool, derived based on the tool's type. For example, display name of a ClientFunction is derived from its `name` property.
+ "etag": "A String", # Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
+ "executionType": "A String", # Optional. The execution type of the tool.
+ "fileSearchTool": { # The file search tool allows the agent to search across the files uploaded by the app/agent developer. It has presets to give relatively good quality search over the uploaded files and summarization of the retrieved results. # Optional. The file search tool.
+ "corpusType": "A String", # Optional. The type of the corpus. Default is FULLY_MANAGED.
+ "description": "A String", # Optional. The tool description.
+ "fileCorpus": "A String", # Optional. The corpus where files are stored. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}
+ "name": "A String", # Required. The tool name.
+ },
+ "generatedSummary": "A String", # Output only. If the tool is generated by the LLM assistant, this field contains a descriptive summary of the generation.
+ "googleSearchTool": { # Represents a tool to perform Google web searches for grounding. See https://cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool#google-search. # Optional. The google search tool.
+ "contextUrls": [ # Optional. Content will be fetched directly from these URLs for context and grounding. Example: "https://example.com/path.html". A maximum of 20 URLs are allowed.
+ "A String",
+ ],
+ "description": "A String", # Optional. Description of the tool's purpose.
+ "excludeDomains": [ # Optional. List of domains to be excluded from the search results. Example: "example.com". A maximum of 2000 domains can be excluded.
+ "A String",
+ ],
+ "name": "A String", # Required. The name of the tool.
+ "preferredDomains": [ # Optional. Specifies domains to restrict search results to. Example: "example.com", "another.site". A maximum of 20 domains can be specified.
+ "A String",
+ ],
+ "promptConfig": { # Prompt settings used by the model when processing or summarizing the google search results. # Optional. Prompt instructions passed to planner on how the search results should be processed for text and voice.
+ "textPrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in chat conversations. If not set, default prompt will be used.
+ "voicePrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in voice conversations. If not set, default prompt will be used.
+ },
+ },
+ "mcpTool": { # An MCP tool. See https://modelcontextprotocol.io/specification/2025-06-18/server/tools for more details. # Optional. The MCP tool. An MCP tool cannot be created or updated directly and is managed by the MCP toolset.
+ "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required to execute the tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication.
+ "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth.
+ "apiKeySecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
+ "requestLocation": "A String", # Required. Key location in the request.
+ },
+ "bearerTokenConfig": { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth.
+ "token": "A String", # Required. The bearer token. Must be in the format `$context.variables.`.
+ },
+ "oauthConfig": { # Configurations for authentication with OAuth. # Optional. Config for OAuth.
+ "clientId": "A String", # Required. The client ID from the OAuth provider.
+ "clientSecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "oauthGrantType": "A String", # Required. OAuth grant types.
+ "scopes": [ # Optional. The OAuth scopes to grant.
+ "A String",
+ ],
+ "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
+ },
+ "serviceAccountAuthConfig": { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication.
+ "scopes": [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.
+ "A String",
+ ],
+ "serviceAccount": "A String", # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ },
+ "serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent.
+ },
+ },
+ "customHeaders": { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details.
+ "a_key": "A String",
+ },
+ "description": "A String", # Optional. The description of the MCP tool.
+ "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the input arguments of the MCP tool.
+ "additionalProperties": # Object with schema name: Schema # 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: Schema
+ ],
+ "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: Schema
+ },
+ "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",
+ ],
+ "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
+ "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+ "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
+ "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+ "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
+ "nullable": True or False, # Optional. Indicates if the value may be null.
+ "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY.
+ # Object with schema name: Schema
+ ],
+ "properties": { # Optional. Properties of Type.OBJECT.
+ "a_key": # Object with schema name: Schema
+ },
+ "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", # Required. The type of the data.
+ "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
+ },
+ "name": "A String", # Required. The name of the MCP tool.
+ "nameOverride": "A String", # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override.
+ "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool.
+ "additionalProperties": # Object with schema name: Schema # 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: Schema
+ ],
+ "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: Schema
+ },
+ "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",
+ ],
+ "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
+ "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+ "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
+ "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+ "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
+ "nullable": True or False, # Optional. Indicates if the value may be null.
+ "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY.
+ # Object with schema name: Schema
+ ],
+ "properties": { # Optional. Properties of Type.OBJECT.
+ "a_key": # Object with schema name: Schema
+ },
+ "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", # Required. The type of the data.
+ "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
+ },
+ "serverAddress": "A String", # Required. The server address of the MCP server, e.g., "https://example.com/mcp/". If the server is built with the MCP SDK, the url should be suffixed with "/mcp/". Only Streamable HTTP transport based servers are supported. This is the same as the server_address in the McpToolset. See https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http for more details.
+ "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter.
+ "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.
+ },
+ "state": "A String", # Output only. The dynamic availability state of the tool on the external server.
+ "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust.
+ "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
+ { # The CA certificate.
+ "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ```
+ "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
+ },
+ ],
+ },
+ },
+ "name": "A String", # Identifier. The resource name of the tool. Format: * `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for standalone tools. * `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only; they cannot be referenced directly where a tool is expected.
+ "openApiTool": { # A remote API tool defined by an OpenAPI schema. # Optional. The open API tool.
+ "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required by the API.
+ "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth.
+ "apiKeySecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
+ "requestLocation": "A String", # Required. Key location in the request.
+ },
+ "bearerTokenConfig": { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth.
+ "token": "A String", # Required. The bearer token. Must be in the format `$context.variables.`.
+ },
+ "oauthConfig": { # Configurations for authentication with OAuth. # Optional. Config for OAuth.
+ "clientId": "A String", # Required. The client ID from the OAuth provider.
+ "clientSecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "oauthGrantType": "A String", # Required. OAuth grant types.
+ "scopes": [ # Optional. The OAuth scopes to grant.
+ "A String",
+ ],
+ "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
+ },
+ "serviceAccountAuthConfig": { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication.
+ "scopes": [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.
+ "A String",
+ ],
+ "serviceAccount": "A String", # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ },
+ "serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent.
+ },
+ },
+ "description": "A String", # Optional. The description of the tool. If not provided, the description of the tool will be derived from the OpenAPI schema, from `operation.description` or `operation.summary`.
+ "ignoreUnknownFields": True or False, # Optional. If true, the agent will ignore unknown fields in the API response.
+ "name": "A String", # Optional. The name of the tool. If not provided, the name of the tool will be derived from the OpenAPI schema, from `operation.operationId`.
+ "openApiSchema": "A String", # Required. The OpenAPI schema in JSON or YAML format.
+ "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration.
+ "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.
+ },
+ "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client will trust.
+ "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
+ { # The CA certificate.
+ "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ```
+ "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
+ },
+ ],
+ },
+ "url": "A String", # Optional. The server URL of the Open API schema. This field is only set in tools in the environment dependencies during the export process if the schema contains a server url. During the import process, if this url is present in the environment dependencies and the schema has the $env_var placeholder, it will replace the placeholder in the schema.
+ },
+ "pythonFunction": { # A Python function tool. # Optional. The python function tool.
+ "description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring.
+ "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used.
+ "pythonCode": "A String", # Optional. The Python code to execute for the tool.
+ "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool.
+ "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.
+ },
+ },
+ "remoteAgentTool": { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool.
+ "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes.
+ "description": "A String", # Required. A description of the agent's domain of action/solution space.
+ "name": "A String", # Required. A human-readable name for the agent.
+ "skills": [ # Required. Skills represent a unit of ability an agent can perform. This may somewhat abstract but represents a more focused set of actions that the agent is highly likely to succeed at.
+ { # Represents a distinct capability or function that an agent can perform.
+ "description": "A String", # Required. A detailed description of the skill.
+ "examples": [ # Example prompts or scenarios that this skill can handle.
+ "A String",
+ ],
+ "id": "A String", # Required. A unique identifier for the agent's skill.
+ "inputModes": [ # The set of supported input media types for this skill, overriding the agent's defaults.
+ "A String",
+ ],
+ "name": "A String", # Required. A human-readable name for the skill.
+ "outputModes": [ # The set of supported output media types for this skill, overriding the agent's defaults.
+ "A String",
+ ],
+ "tags": [ # Required. A set of keywords describing the skill's capabilities.
+ "A String",
+ ],
+ },
+ ],
+ "supportedInterfaces": [ # Required. Ordered list of supported interfaces. The first entry is preferred.
+ { # Declares a combination of a target URL, transport and protocol version for interacting with the agent. This allows agents to expose the same functionality over multiple protocol binding mechanisms.
+ "protocolBinding": "A String", # Required. The protocol binding supported at this URL. This is an open form string, to be easily extended for other protocol bindings. The core ones officially supported are `JSONRPC`, `GRPC` and `HTTP+JSON`.
+ "protocolVersion": "A String", # Required. The version of the A2A protocol this interface exposes. Use the latest supported minor version per major version. Examples: "0.3", "1.0"
+ "tenant": "A String", # Tenant ID to be used in the request when calling the agent.
+ "url": "A String", # Required. The URL where this interface is available. Must be a valid absolute HTTPS URL in production. Example: "https://api.example.com/a2a/v1", "https://grpc.example.com/a2a"
+ },
+ ],
+ "version": "A String", # Required. The version of the agent.
+ },
+ "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication configuration for calling the remote agent.
+ "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth.
+ "apiKeySecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
+ "requestLocation": "A String", # Required. Key location in the request.
+ },
+ "bearerTokenConfig": { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth.
+ "token": "A String", # Required. The bearer token. Must be in the format `$context.variables.`.
+ },
+ "oauthConfig": { # Configurations for authentication with OAuth. # Optional. Config for OAuth.
+ "clientId": "A String", # Required. The client ID from the OAuth provider.
+ "clientSecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "oauthGrantType": "A String", # Required. OAuth grant types.
+ "scopes": [ # Optional. The OAuth scopes to grant.
+ "A String",
+ ],
+ "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
+ },
+ "serviceAccountAuthConfig": { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication.
+ "scopes": [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.
+ "A String",
+ ],
+ "serviceAccount": "A String", # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ },
+ "serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent.
+ },
+ },
+ "description": "A String", # Required. The description of the tool.
+ "name": "A String", # Required. The name of the tool.
+ },
+ "systemTool": { # Pre-defined system tool. # Optional. The system tool.
+ "description": "A String", # Output only. The description of the system tool.
+ "name": "A String", # Required. The name of the system tool.
+ },
+ "timeout": "A String", # Optional. The timeout for the tool execution. If not set, the default timeout is 30 seconds for `SYNCHRONOUS` tools and 60 seconds for `ASYNCHRONOUS` tools.
+ "toolFakeConfig": { # Configuration for tool behavior in fake mode. # Optional. Configuration for tool behavior in fake mode.
+ "codeBlock": { # A code block to be executed instead of a real tool call. # Optional. Code block which will be executed instead of a real tool call.
+ "pythonCode": "A String", # Required. Python code which will be invoked in tool fake mode. Expected Python function signature - To catch all tool calls: def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: To catch a specific tool call: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: If the function returns None, the real tool will be invoked instead.
+ },
+ "enableFakeMode": True or False, # Optional. Whether the tool is using fake mode.
+ },
+ "updateTime": "A String", # Output only. Timestamp when the tool was last updated.
+ "widgetTool": { # Represents a widget tool that the agent can invoke. When the tool is chosen by the agent, agent will return the widget to the client. The client is responsible for processing the widget and generating the next user query to continue the interaction with the agent. # Optional. The widget tool.
+ "dataMapping": { # Configuration for mapping data from a source tool to the widget's input parameters. # Optional. The mapping that defines how data from a source tool is mapped to the widget's input parameters.
+ "fieldMappings": { # Optional. A map of widget input parameter fields to the corresponding output fields of the source tool.
+ "a_key": "A String",
+ },
+ "mode": "A String", # Optional. The mode of the data mapping.
+ "pythonFunction": { # A Python function tool. # Optional. Configuration for a Python function used to transform the source tool's output into the widget's input format.
+ "description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring.
+ "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used.
+ "pythonCode": "A String", # Optional. The Python code to execute for the tool.
+ "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool.
+ "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.
+ },
+ },
+ "pythonScript": "A String", # Deprecated: Use `python_function` instead.
+ "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}`
+ },
+ "description": "A String", # Optional. The description of the widget tool.
+ "name": "A String", # Required. The display name of the widget tool.
+ "parameters": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The input parameters of the widget tool.
+ "additionalProperties": # Object with schema name: Schema # 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: Schema
+ ],
+ "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: Schema
+ },
+ "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",
+ ],
+ "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
+ "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+ "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
+ "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+ "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
+ "nullable": True or False, # Optional. Indicates if the value may be null.
+ "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY.
+ # Object with schema name: Schema
+ ],
+ "properties": { # Optional. Properties of Type.OBJECT.
+ "a_key": # Object with schema name: Schema
+ },
+ "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", # Required. The type of the data.
+ "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
+ },
+ "textResponseConfig": { # Configuration for the text response returned with the widget. # Optional. Configuration for always-included text responses.
+ "staticText": "A String", # Optional. The static text response to return when type is STATIC.
+ "textResponseInstruction": "A String", # Optional. Instruction for the LLM on how to generate the text response. Used as the description for the text response parameter if type is LLM_GENERATED.
+ "type": "A String", # Optional. The strategy for providing the text response.
+ },
+ "uiConfig": { # Optional. Configuration for rendering the widget.
+ "a_key": "", # Properties of the object.
+ },
+ "widgetType": "A String", # Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED.
+ },
+ },
+ ],
+ "toolsets": [ # Optional. List of toolsets in the app.
+ { # A toolset represents a group of dynamically managed tools that can be used by the agent.
+ "connectorToolset": { # A toolset that generates tools from an Integration Connectors Connection. # Optional. A toolset that generates tools from an Integration Connectors Connection.
+ "authConfig": { # End-user authentication configuration used for Connection calls. The field values must be the names of context variables in the format `$context.variables.`. # Optional. Configures how authentication is handled in Integration Connectors. By default, an admin authentication is passed in the Integration Connectors API requests. You can override it with a different end-user authentication config. **Note**: The Connection must have authentication override enabled in order to specify an EUC configuration here - otherwise, the Toolset creation will fail. See: https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override
+ "oauth2AuthCodeConfig": { # Oauth 2.0 Authorization Code authentication configuration. # Oauth 2.0 Authorization Code authentication.
+ "oauthToken": "A String", # Required. Oauth token parameter name to pass through. Must be in the format `$context.variables.`.
+ },
+ "oauth2JwtBearerConfig": { # JWT Profile Oauth 2.0 Authorization Grant authentication configuration. # JWT Profile Oauth 2.0 Authorization Grant authentication.
+ "clientKey": "A String", # Required. Client parameter name to pass through. Must be in the format `$context.variables.`.
+ "issuer": "A String", # Required. Issuer parameter name to pass through. Must be in the format `$context.variables.`.
+ "subject": "A String", # Required. Subject parameter name to pass through. Must be in the format `$context.variables.`.
+ },
+ },
+ "connection": "A String", # Required. The full resource name of the referenced Integration Connectors Connection. Format: `projects/{project}/locations/{location}/connections/{connection}`
+ "connectorActions": [ # Required. The list of connector actions/entity operations to generate tools for.
+ { # Configuration of an Action for the tool to use. Note: This can be either an Action or an Operation. See https://cloud.google.com/integration-connectors/docs/entities-operation-action for details.
+ "connectionActionId": "A String", # ID of a Connection action for the tool to use.
+ "entityOperation": { # Entity CRUD operation specification. # Entity operation configuration for the tool to use.
+ "entityId": "A String", # Required. ID of the entity.
+ "operation": "A String", # Required. Operation to perform on the entity.
+ },
+ "inputFields": [ # Optional. Entity fields to use as inputs for the operation. If no fields are specified, all fields of the Entity will be used.
+ "A String",
+ ],
+ "outputFields": [ # Optional. Entity fields to return from the operation. If no fields are specified, all fields of the Entity will be returned.
+ "A String",
+ ],
+ },
+ ],
+ },
+ "createTime": "A String", # Output only. Timestamp when the toolset was created.
+ "description": "A String", # Optional. The description of the toolset.
+ "displayName": "A String", # Optional. The display name of the toolset. Must be unique within the same app.
+ "etag": "A String", # ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
+ "executionType": "A String", # Optional. The execution type of the tools in the toolset.
+ "mcpToolset": { # A toolset that contains a list of tools that are offered by the MCP server. # Optional. A toolset that contains a list of tools that are offered by the MCP server.
+ "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required to access tools and execute a tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication.
+ "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth.
+ "apiKeySecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
+ "requestLocation": "A String", # Required. Key location in the request.
+ },
+ "bearerTokenConfig": { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth.
+ "token": "A String", # Required. The bearer token. Must be in the format `$context.variables.`.
+ },
+ "oauthConfig": { # Configurations for authentication with OAuth. # Optional. Config for OAuth.
+ "clientId": "A String", # Required. The client ID from the OAuth provider.
+ "clientSecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "oauthGrantType": "A String", # Required. OAuth grant types.
+ "scopes": [ # Optional. The OAuth scopes to grant.
+ "A String",
+ ],
+ "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
+ },
+ "serviceAccountAuthConfig": { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication.
+ "scopes": [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.
+ "A String",
+ ],
+ "serviceAccount": "A String", # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ },
+ "serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent.
+ },
+ },
+ "customHeaders": { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details.
+ "a_key": "A String",
+ },
+ "serverAddress": "A String", # Required. The address of the MCP server, for example, "https://example.com/mcp/". If the server is built with the MCP SDK, the url should be suffixed with "/mcp/". Only Streamable HTTP transport based servers are supported. See https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http for more details.
+ "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter.
+ "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.
+ },
+ "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust.
+ "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
+ { # The CA certificate.
+ "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ```
+ "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
+ },
+ ],
+ },
+ "toolOverrides": [ # Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic.
+ { # Overrides associated with a given tool in a Toolset. This enables "pinning" or "overriding" of tool definitions from the external dynamic server.
+ "descriptionOverride": "A String", # Optional. If present, this tool uses this description instead of the original description from the server.
+ "nameOverride": "A String", # Optional. If present, this tool uses this name in the Agent instead of the original name. This is primarily used as an alias if the MCP server offers poorly named tools.
+ "snapshot": { # Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden. # Output only. If present, this tool is "Pinned" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present.
+ "description": "A String", # Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`.
+ "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the input arguments of the MCP tool.
+ "additionalProperties": # Object with schema name: Schema # 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: Schema
+ ],
+ "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: Schema
+ },
+ "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",
+ ],
+ "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
+ "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+ "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
+ "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+ "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
+ "nullable": True or False, # Optional. Indicates if the value may be null.
+ "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY.
+ # Object with schema name: Schema
+ ],
+ "properties": { # Optional. Properties of Type.OBJECT.
+ "a_key": # Object with schema name: Schema
+ },
+ "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", # Required. The type of the data.
+ "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
+ },
+ "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the output arguments of the MCP tool.
+ "additionalProperties": # Object with schema name: Schema # 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: Schema
+ ],
+ "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: Schema
+ },
+ "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",
+ ],
+ "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
+ "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+ "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
+ "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+ "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
+ "nullable": True or False, # Optional. Indicates if the value may be null.
+ "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY.
+ # Object with schema name: Schema
+ ],
+ "properties": { # Optional. Properties of Type.OBJECT.
+ "a_key": # Object with schema name: Schema
+ },
+ "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", # Required. The type of the data.
+ "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
+ },
+ },
+ "tool": "A String", # Required. The original name of the tool as it is emitted by the MCP server.
+ },
+ ],
+ },
+ "name": "A String", # Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
+ "openApiToolset": { # A toolset that contains a list of tools that are defined by an OpenAPI schema. # Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema.
+ "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required by the API.
+ "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth.
+ "apiKeySecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
+ "requestLocation": "A String", # Required. Key location in the request.
+ },
+ "bearerTokenConfig": { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth.
+ "token": "A String", # Required. The bearer token. Must be in the format `$context.variables.`.
+ },
+ "oauthConfig": { # Configurations for authentication with OAuth. # Optional. Config for OAuth.
+ "clientId": "A String", # Required. The client ID from the OAuth provider.
+ "clientSecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "oauthGrantType": "A String", # Required. OAuth grant types.
+ "scopes": [ # Optional. The OAuth scopes to grant.
+ "A String",
+ ],
+ "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
+ },
+ "serviceAccountAuthConfig": { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication.
+ "scopes": [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.
+ "A String",
+ ],
+ "serviceAccount": "A String", # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ },
+ "serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent.
+ },
+ },
+ "ignoreUnknownFields": True or False, # Optional. If true, the agent will ignore unknown fields in the API response for all operations defined in the OpenAPI schema.
+ "openApiSchema": "A String", # Required. The OpenAPI schema of the toolset.
+ "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration.
+ "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.
+ },
+ "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates
+ "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
+ { # The CA certificate.
+ "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ```
+ "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
+ },
+ ],
+ },
+ "url": "A String", # Optional. The server URL of the Open API schema. This field is only set in toolsets in the environment dependencies during the export process if the schema contains a server url. During the import process, if this url is present in the environment dependencies and the schema has the $env_var placeholder, it will replace the placeholder in the schema.
+ },
+ "timeout": "A String", # Optional. The timeout for the toolset execution. If not set, the default timeout is 30 seconds for `SYNCHRONOUS` toolsets and 60 seconds for `ASYNCHRONOUS` toolsets.
+ "toolFakeConfig": { # Configuration for tool behavior in fake mode. # Optional. Configuration for tools behavior in fake mode.
+ "codeBlock": { # A code block to be executed instead of a real tool call. # Optional. Code block which will be executed instead of a real tool call.
+ "pythonCode": "A String", # Required. Python code which will be invoked in tool fake mode. Expected Python function signature - To catch all tool calls: def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: To catch a specific tool call: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: If the function returns None, the real tool will be invoked instead.
+ },
+ "enableFakeMode": True or False, # Optional. Whether the tool is using fake mode.
+ },
+ "updateTime": "A String", # Output only. Timestamp when the toolset was last updated.
+ },
+ ],
+ },
+ "updateTime": "A String", # Output only. Timestamp when the app version was last updated.
+}
+
+ updateMask: string, Optional. The list of fields to update. If empty, fields `display_name` and `description` will be updated.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # In Customer Engagement Suite (CES), an app version is a snapshot of the app at a specific point in time. It is immutable and cannot be modified once created.
+ "createTime": "A String", # Output only. Timestamp when the app version was created.
+ "creator": "A String", # Output only. Email of the user who created the app version.
+ "description": "A String", # Optional. The description of the app version.
+ "displayName": "A String", # Optional. The display name of the app version.
+ "etag": "A String", # Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
+ "name": "A String", # Identifier. The unique identifier of the app version. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`
+ "snapshot": { # A snapshot of the app. # Output only. The snapshot of the app when the version is created.
+ "agents": [ # Optional. List of agents in the app.
+ { # An agent acts as the fundamental building block that provides instructions to the Large Language Model (LLM) for executing specific tasks.
+ "afterAgentCallbacks": [ # Optional. The callbacks to execute after the agent is called. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.
+ { # A callback defines the custom logic to be executed at various stages of agent interaction.
+ "description": "A String", # Optional. Human-readable description of the callback.
+ "disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
+ "pythonCode": "A String", # Required. The python code to execute for the callback.
+ },
+ ],
+ "afterModelCallbacks": [ # Optional. The callbacks to execute after the model is called. If there are multiple calls to the model, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.
+ { # A callback defines the custom logic to be executed at various stages of agent interaction.
+ "description": "A String", # Optional. Human-readable description of the callback.
+ "disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
+ "pythonCode": "A String", # Required. The python code to execute for the callback.
+ },
+ ],
+ "afterToolCallbacks": [ # Optional. The callbacks to execute after the tool is invoked. If there are multiple tool invocations, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.
+ { # A callback defines the custom logic to be executed at various stages of agent interaction.
+ "description": "A String", # Optional. Human-readable description of the callback.
+ "disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
+ "pythonCode": "A String", # Required. The python code to execute for the callback.
+ },
+ ],
+ "beforeAgentCallbacks": [ # Optional. The callbacks to execute before the agent is called. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.
+ { # A callback defines the custom logic to be executed at various stages of agent interaction.
+ "description": "A String", # Optional. Human-readable description of the callback.
+ "disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
+ "pythonCode": "A String", # Required. The python code to execute for the callback.
+ },
+ ],
+ "beforeModelCallbacks": [ # Optional. The callbacks to execute before the model is called. If there are multiple calls to the model, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.
+ { # A callback defines the custom logic to be executed at various stages of agent interaction.
+ "description": "A String", # Optional. Human-readable description of the callback.
+ "disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
+ "pythonCode": "A String", # Required. The python code to execute for the callback.
+ },
+ ],
+ "beforeToolCallbacks": [ # Optional. The callbacks to execute before the tool is invoked. If there are multiple tool invocations, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.
+ { # A callback defines the custom logic to be executed at various stages of agent interaction.
+ "description": "A String", # Optional. Human-readable description of the callback.
+ "disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
+ "pythonCode": "A String", # Required. The python code to execute for the callback.
+ },
+ ],
+ "childAgents": [ # Optional. List of child agents in the agent tree. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
+ "A String",
+ ],
+ "createTime": "A String", # Output only. Timestamp when the agent was created.
+ "description": "A String", # Optional. Human-readable description of the agent.
+ "displayName": "A String", # Required. Display name of the agent.
+ "etag": "A String", # Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
+ "generatedSummary": "A String", # Output only. If the agent is generated by the LLM assistant, this field contains a descriptive summary of the generation.
+ "guardrails": [ # Optional. List of guardrails for the agent. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`
+ "A String",
+ ],
+ "instruction": "A String", # Optional. Instructions for the LLM model to guide the agent's behavior.
+ "llmAgent": { # Default agent type. The agent uses instructions and callbacks specified in the agent to perform the task using a large language model. # Optional. The default agent type.
+ },
+ "modelSettings": { # Model settings contains various configurations for the LLM model. # Optional. Configurations for the LLM model.
+ "model": "A String", # Optional. The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
+ "temperature": 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
+ },
+ "name": "A String", # Identifier. The unique identifier of the agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
+ "remoteA2aAgent": { # The agent which will transfer execution to a remote [A2A](https://github.com/a2aproject/A2A) agent. # Optional. The remote [A2A](https://github.com/a2aproject/A2A) agent to be used for the agent execution.
+ "a2aConfig": { # Shared configuration for connecting to a remote [A2A](https://github.com/a2aproject/A2A) agent. # Required. The A2A connection configuration.
+ "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Optional. The full agent card defined inline.
+ "description": "A String", # Required. A description of the agent's domain of action/solution space.
+ "name": "A String", # Required. A human-readable name for the agent.
+ "skills": [ # Required. Skills represent a unit of ability an agent can perform. This may somewhat abstract but represents a more focused set of actions that the agent is highly likely to succeed at.
+ { # Represents a distinct capability or function that an agent can perform.
+ "description": "A String", # Required. A detailed description of the skill.
+ "examples": [ # Example prompts or scenarios that this skill can handle.
+ "A String",
+ ],
+ "id": "A String", # Required. A unique identifier for the agent's skill.
+ "inputModes": [ # The set of supported input media types for this skill, overriding the agent's defaults.
+ "A String",
+ ],
+ "name": "A String", # Required. A human-readable name for the skill.
+ "outputModes": [ # The set of supported output media types for this skill, overriding the agent's defaults.
+ "A String",
+ ],
+ "tags": [ # Required. A set of keywords describing the skill's capabilities.
+ "A String",
+ ],
+ },
+ ],
+ "supportedInterfaces": [ # Required. Ordered list of supported interfaces. The first entry is preferred.
+ { # Declares a combination of a target URL, transport and protocol version for interacting with the agent. This allows agents to expose the same functionality over multiple protocol binding mechanisms.
+ "protocolBinding": "A String", # Required. The protocol binding supported at this URL. This is an open form string, to be easily extended for other protocol bindings. The core ones officially supported are `JSONRPC`, `GRPC` and `HTTP+JSON`.
+ "protocolVersion": "A String", # Required. The version of the A2A protocol this interface exposes. Use the latest supported minor version per major version. Examples: "0.3", "1.0"
+ "tenant": "A String", # Tenant ID to be used in the request when calling the agent.
+ "url": "A String", # Required. The URL where this interface is available. Must be a valid absolute HTTPS URL in production. Example: "https://api.example.com/a2a/v1", "https://grpc.example.com/a2a"
+ },
+ ],
+ "version": "A String", # Required. The version of the agent.
+ },
+ "agentRegistry": "A String", # Optional. Reference to the agent in the Agent Registry. Format: `projects/{project}/locations/{location}/agents/{agent}`
+ "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication configuration for calling the remote agent. Optional if the registry reference already handles authentication.
+ "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth.
+ "apiKeySecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
+ "requestLocation": "A String", # Required. Key location in the request.
+ },
+ "bearerTokenConfig": { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth.
+ "token": "A String", # Required. The bearer token. Must be in the format `$context.variables.`.
+ },
+ "oauthConfig": { # Configurations for authentication with OAuth. # Optional. Config for OAuth.
+ "clientId": "A String", # Required. The client ID from the OAuth provider.
+ "clientSecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "oauthGrantType": "A String", # Required. OAuth grant types.
+ "scopes": [ # Optional. The OAuth scopes to grant.
+ "A String",
+ ],
+ "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
+ },
+ "serviceAccountAuthConfig": { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication.
+ "scopes": [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.
+ "A String",
+ ],
+ "serviceAccount": "A String", # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ },
+ "serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent.
+ },
+ },
+ "contextId": "A String", # Optional. If not empty, interactions with the remote A2A agent will use this context ID. This context_id field can refer to a session variable like `$context.variables.order_agent_session_id`.
+ "inputVariableMapping": { # Optional. Mapping of input variable names of remote agent to GECX variable names.
+ "a_key": "A String",
+ },
+ "outputVariableMapping": { # Optional. Mapping of output variable names of remote agent to GECX variable names.
+ "a_key": "A String",
+ },
+ "streamingEnabled": True or False, # Optional. Whether streaming is enabled for the remote agent.
+ },
+ },
+ "remoteDialogflowAgent": { # The agent which will transfer execution to a remote [Dialogflow CX](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent. The Dialogflow agent will process subsequent user queries until the session ends or flow ends, and the control is transferred back to the parent CES agent. # Optional. The remote [Dialogflow](https://cloud.google.com/dialogflow/cx/docs/concept/console-conversational-agents) agent to be used for the agent execution. If this field is set, all other agent level properties will be ignored. Note: If the Dialogflow agent is in a different project from the app, you should grant `roles/dialogflow.client` to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "agent": "A String", # Required. The [Dialogflow](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent resource name. Format: `projects/{project}/locations/{location}/agents/{agent}`
+ "environmentId": "A String", # Optional. The environment ID of the Dialogflow agent to be used for the agent execution. If not specified, the draft environment will be used.
+ "flowId": "A String", # Optional. The flow ID of the flow in the Dialogflow agent.
+ "inputVariableMapping": { # Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input.
+ "a_key": "A String",
+ },
+ "languageCodeVariable": "A String", # Optional. The name of the variable that contains the language code to be used for the Dialogflow session. If unspecified, the default language code of the Dialogflow agent will be used.
+ "outputVariableMapping": { # Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends.
+ "a_key": "A String",
+ },
+ "respectResponseInterruptionSettings": True or False, # Optional. Indicates whether to respect the message-level interruption settings configured in the Dialogflow agent. * If false: all response messages from the Dialogflow agent follow the app-level barge-in settings. * If true: only response messages with [`allow_playback_interruption`](https://docs.cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#text) set to true will be interruptable, all other messages follow the app-level barge-in settings.
+ },
+ "tools": [ # Optional. List of available tools for the agent. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
+ "A String",
+ ],
+ "toolsets": [ # Optional. List of toolsets for the agent.
+ { # A toolset with a selection of its tools.
+ "toolIds": [ # Optional. The tools IDs to filter the toolset.
+ "A String",
+ ],
+ "toolset": "A String", # Required. The resource name of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
+ },
+ ],
+ "transferRules": [ # Optional. Agent transfer rules. If multiple rules match, the first one in the list will be used.
+ { # Rule for transferring to a specific agent.
+ "childAgent": "A String", # Required. The resource name of the child agent the rule applies to. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
+ "deterministicTransfer": { # Deterministic transfer rule. When the condition evaluates to true, the transfer occurs. # Optional. A rule that immediately transfers to the target agent when the condition is met.
+ "expressionCondition": { # Expression condition based on session state. # Optional. A rule that evaluates a session state condition. If the condition evaluates to true, the transfer occurs.
+ "expression": "A String", # Required. The string representation of cloud.api.Expression condition.
+ },
+ "pythonCodeCondition": { # Python code block to evaluate the condition. # Optional. A rule that uses Python code block to evaluate the conditions. If the condition evaluates to true, the transfer occurs.
+ "pythonCode": "A String", # Required. The python code to execute.
+ },
+ },
+ "direction": "A String", # Required. The direction of the transfer.
+ "disablePlannerTransfer": { # A rule that prevents the planner from transferring to the target agent. # Optional. Rule that prevents the planner from transferring to the target agent.
+ "expressionCondition": { # Expression condition based on session state. # Required. If the condition evaluates to true, planner will not be allowed to transfer to the target agent.
+ "expression": "A String", # Required. The string representation of cloud.api.Expression condition.
+ },
+ },
+ },
+ ],
+ "updateTime": "A String", # Output only. Timestamp when the agent was last updated.
+ "validationErrors": [ # Output only. Misconfigurations or errors in the agent that may affect agent quality.
+ "A String",
+ ],
+ },
+ ],
+ "app": { # An app serves as a top-level container for a group of agents, including the root agent and its sub-agents, along with their associated configurations. These agents work together to achieve specific goals within the app's context. # Optional. The basic settings for the app.
+ "audioProcessingConfig": { # Configuration for how the input and output audio should be processed and delivered. # Optional. Audio processing configuration of the app.
+ "ambientSoundConfig": { # Configuration for the ambient sound to be played with the synthesized agent response, to enhance the naturalness of the conversation. # Optional. Configuration for the ambient sound to be played with the synthesized agent response, to enhance the naturalness of the conversation.
+ "gcsUri": "A String", # Optional. Ambient noise as a mono-channel, 16kHz WAV file stored in [Cloud Storage](https://cloud.google.com/storage). Note: Please make sure the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com` has `storage.objects.get` permission to the Cloud Storage object.
+ "prebuiltAmbientNoise": "A String", # Optional. Deprecated: `prebuilt_ambient_noise` is deprecated in favor of `prebuilt_ambient_sound`.
+ "prebuiltAmbientSound": "A String", # Optional. Name of the prebuilt ambient sound. Valid values are: - "coffee_shop" - "keyboard" - "keypad" - "hum" - "office_1" - "office_2" - "office_3" - "room_1" - "room_2" - "room_3" - "room_4" - "room_5" - "air_conditioner"
+ "volumeGainDb": 3.14, # Optional. Volume gain (in dB) of the normal native volume supported by ambient noise, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.
+ },
+ "bargeInConfig": { # Configuration for how the user barge-in activities should be handled. # Optional. Configures the agent behavior for the user barge-in activities.
+ "bargeInAwareness": True or False, # Optional. If enabled, the agent will adapt its next response based on the assumption that the user hasn't heard the full preceding agent message. This should not be used in scenarios where agent responses are displayed visually.
+ "disableBargeIn": True or False, # Optional. Deprecated: `disable_barge_in` is deprecated in favor of `disable_barge_in_control` in ChannelProfile. Disables user barge-in while the agent is speaking. If true, user input during agent response playback will be ignored.
+ },
+ "customVoiceSamples": [ # Optional. Configures custom voice samples for voice cloning.
+ { # Configuration for a custom voice sample used for voice cloning.
+ "consentAudioGcsUri": "A String", # Optional. Consent audio for voice cloning.
+ "name": "A String", # Optional. The user-defined name for the custom voice sample.
+ "previewAudioContent": "A String", # Output only. Synthesized preview audio for custom voice, formatted as canonical WAV (LINEAR16, 24kHz, 16-bit, mono).
+ "previewText": "A String", # Optional. Text for synthesizing preview audio for custom voice.
+ "voiceInstruction": "A String", # Optional. Natural language instructions for voice style, tone, pacing, or pronunciation.
+ "voiceSampleGcsUri": "A String", # Optional. The Cloud Storage URI to the audio sample for voice cloning. The audio sample should be a mono-channel, 24kHz WAV file.
+ },
+ ],
+ "inactivityTimeout": "A String", # Optional. The duration of user inactivity (no speech or interaction) before the agent prompts the user for reengagement. If not set, the agent will not prompt the user for reengagement.
+ "synthesizeSpeechConfigs": { # Optional. Configuration of how the agent response should be synthesized, mapping from the language code to SynthesizeSpeechConfig. If the configuration for the specified language code is not found, the configuration for the root language code will be used. For example, if the map contains "en-us" and "en", and the specified language code is "en-gb", then "en" configuration will be used. Note: Language code is case-insensitive.
+ "a_key": { # Configuration for how the agent response should be synthesized.
+ "consentAudioGcsUri": "A String", # Optional. Deprecated: Use `custom_voice_samples` in AudioProcessingConfig instead. The Cloud Storage URI to the consent audio for voice cloning.
+ "instruction": "A String", # Optional. The instruction used to synthesize speech when using a generative model.
+ "model": "A String", # Optional. The model used to synthesize audio. Currently supported values: - "gemini-3.1-flash-tts-preview" If empty, Chirp3-HD is used.
+ "speakingRate": 3.14, # Optional. The speaking rate/speed in the range [0.25, 2.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. Values outside of the range [0.25, 2.0] will return an error.
+ "voice": "A String", # Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices) from Cloud Text-to-Speech.
+ "voiceSampleGcsUri": "A String", # Optional. Deprecated: Use `custom_voice_samples` in AudioProcessingConfig instead. The Cloud Storage URI to the audio sample for voice cloning. The audio sample should be a mono-channel, 24kHz WAV file. Note: Please make sure the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com` has `storage.objects.get` permission to the Cloud Storage object.
+ },
+ },
+ },
+ "clientCertificateSettings": { # Settings for custom client certificates. # Optional. The default client certificate settings for the app.
+ "passphrase": "A String", # Optional. The name of the SecretManager secret version resource storing the passphrase to decrypt the private key. Should be left unset if the private key is not encrypted. Format: `projects/{project}/secrets/{secret}/versions/{version}`
+ "privateKey": "A String", # Required. The name of the SecretManager secret version resource storing the private key encoded in PEM format. Format: `projects/{project}/secrets/{secret}/versions/{version}`
+ "tlsCertificate": "A String", # Required. The TLS certificate encoded in PEM format. This string must include the begin header and end footer lines.
+ },
+ "createTime": "A String", # Output only. Timestamp when the app was created.
+ "dashboardSettings": { # Settings for dashboards associated with the app, that show up in the Monitoring view. # Optional. App-specific dashboard settings for linking and configuring Contact Center Insights dashboards.
+ "defaultDashboard": "A String", # Optional. The resource name of the default Contact Center Insights dashboard associated with the app. This is the dashboard that will be displayed when users navigate to the Monitoring view for the app. Format: `projects/{project}/locations/{location}/dashboards/{dashboard}`
+ },
+ "dataStoreSettings": { # Data store related settings for the app. # Optional. The data store settings for the app.
+ "engines": [ # Output only. The engines for the app.
+ { # An engine to which the data stores are connected. See Vertex AI Search: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction.
+ "name": "A String", # Output only. The resource name of the engine. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
+ "type": "A String", # Output only. The type of the engine.
+ },
+ ],
+ },
+ "defaultChannelProfile": { # A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony. # Optional. The default channel profile used by the app.
+ "channelType": "A String", # Optional. The type of the channel profile.
+ "disableBargeInControl": True or False, # Optional. Whether to disable user barge-in control in the conversation. - **true**: User interruptions are disabled while the agent is speaking. - **false**: The agent retains automatic control over when the user can interrupt.
+ "disableDtmf": True or False, # Optional. Whether to disable DTMF (dual-tone multi-frequency).
+ "instagramConfig": { # Configuration specific to Instagram deployments. # Optional. Configuration specific to Instagram deployments.
+ "description": "A String", # Output only. The description of the Meta business page or profile.
+ "displayName": "A String", # Output only. The fetched Meta business page name.
+ "instagramAccountId": "A String", # Required. The Instagram Account ID.
+ "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL.
+ },
+ "noiseSuppressionLevel": "A String", # Optional. The noise suppression level of the channel profile. Available values are "low", "moderate", "high", "very_high".
+ "personaProperty": { # Represents the persona property of a channel. # Optional. The persona property of the channel profile.
+ "persona": "A String", # Optional. The persona of the channel.
+ },
+ "profileId": "A String", # Optional. The unique identifier of the channel profile.
+ "webWidgetConfig": { # Message for configuration for the web widget. # Optional. The configuration for the web widget.
+ "modality": "A String", # Optional. The modality of the web widget.
+ "securitySettings": { # Security settings for the web widget. # Optional. The security settings of the web widget.
+ "allowedOrigins": [ # Optional. The origins that are allowed to host the web widget. An origin is defined by RFC 6454. If empty, all origins are allowed. A maximum of 100 origins is allowed. Example: "https://example.com"
+ "A String",
+ ],
+ "enableOriginCheck": True or False, # Optional. Indicates whether origin check for the web widget is enabled. If `true`, the web widget will check the origin of the website that loads the web widget and only allow it to be loaded in the same origin or any of the allowed origins.
+ "enablePublicAccess": True or False, # Optional. Indicates whether public access to the web widget is enabled. If `true`, the web widget will be publicly accessible. If `false`, the web widget must be integrated with your own authentication and authorization system to return valid credentials for accessing the CES agent.
+ "enableRecaptcha": True or False, # Optional. Indicates whether reCAPTCHA verification for the web widget is enabled.
+ },
+ "theme": "A String", # Optional. The theme of the web widget.
+ "webWidgetTitle": "A String", # Optional. The title of the web widget.
+ },
+ "whatsappConfig": { # Configuration specific to WhatsApp deployments. # Optional. Configuration specific to WhatsApp deployments.
+ "description": "A String", # Output only. The description of the Meta business page or profile.
+ "displayName": "A String", # Output only. The fetched Meta business page name.
+ "phoneNumber": "A String", # Optional. The phone number in E.164 format.
+ "phoneNumberId": "A String", # Required. The Meta phone number ID.
+ "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL.
+ "wabaId": "A String", # Required. The WhatsApp Business Account ID.
+ },
+ },
+ "deploymentCount": 42, # Output only. Number of deployments in the app.
+ "description": "A String", # Optional. Human-readable description of the app.
+ "displayName": "A String", # Required. Display name of the app.
+ "errorHandlingSettings": { # Settings to describe how errors should be handled in the app. # Optional. Error handling settings of the app.
+ "endSessionConfig": { # Configuration for ending the session in case of system errors (e.g. LLM errors). # Optional. Configuration for ending the session in case of system errors (e.g. LLM errors).
+ "escalateSession": True or False, # Optional. Whether to escalate the session in EndSession. If session is escalated, metadata in EndSession will contain `session_escalated = true`. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/deploy/google-telephony-platform#transfer_a_call_to_a_human_agent for details.
+ },
+ "errorHandlingStrategy": "A String", # Optional. The strategy to use for error handling.
+ "fallbackResponseConfig": { # Configuration for handling fallback responses. # Optional. Configuration for handling fallback responses.
+ "customFallbackMessages": { # Optional. The fallback messages in case of system errors (e.g. LLM errors), mapped by [supported language code](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/reference/language).
+ "a_key": "A String",
+ },
+ "maxFallbackAttempts": 42, # Optional. The maximum number of fallback attempts to make before the agent emitting EndSession Signal.
+ },
+ },
+ "etag": "A String", # Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
+ "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Optional. The evaluation thresholds for the app.
+ "goldenEvaluationMetricsThresholds": { # Settings for golden evaluations. # Optional. The golden evaluation metrics thresholds.
+ "expectationLevelMetricsThresholds": { # Expectation level metrics thresholds. # Optional. The expectation level metrics thresholds.
+ "toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0.
+ },
+ "toolMatchingSettings": { # Settings for matching tool calls. # Optional. The tool matching settings. An extra tool call is a tool call that is present in the execution but does not match any tool call in the golden expectation.
+ "extraToolCallBehavior": "A String", # Optional. Behavior for extra tool calls. Defaults to FAIL.
+ },
+ "turnLevelMetricsThresholds": { # Turn level metrics thresholds. # Optional. The turn level metrics thresholds.
+ "overallToolInvocationCorrectnessThreshold": 3.14, # Optional. The success threshold for overall tool invocation correctness. Must be a float between 0 and 1. Default is 1.0.
+ "semanticSimilarityChannel": "A String", # Optional. The semantic similarity channel to use for evaluation.
+ "semanticSimilaritySuccessThreshold": 42, # Optional. The success threshold for semantic similarity. Must be an integer between 0 and 4. Default is >= 3.
+ },
+ },
+ "goldenHallucinationMetricBehavior": "A String", # Optional. The hallucination metric behavior for golden evaluations.
+ "hallucinationMetricBehavior": "A String", # Optional. Deprecated: Use `golden_hallucination_metric_behavior` instead. The hallucination metric behavior is currently used for golden evaluations.
+ "scenarioHallucinationMetricBehavior": "A String", # Optional. The hallucination metric behavior for scenario evaluations.
+ },
+ "globalInstruction": "A String", # Optional. Instructions for all the agents in the app. You can use this instruction to set up a stable identity or personality across all the agents.
+ "guardrails": [ # Optional. List of guardrails for the app. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`
+ "A String",
+ ],
+ "languageSettings": { # Language settings of the app. # Optional. Language settings of the app.
+ "defaultLanguageCode": "A String", # Optional. The default language code of the app.
+ "enableMultilingualSupport": True or False, # Optional. Enables multilingual support. If true, agents in the app will use pre-built instructions to improve handling of multilingual input.
+ "fallbackAction": "A String", # Optional. Deprecated: This feature is no longer supported. Use `enable_multilingual_support` instead to improve handling of multilingual input. The action to perform when an agent receives input in an unsupported language. This can be a predefined action or a custom tool call. Valid values are: - A tool's full resource name, which triggers a specific tool execution. - A predefined system action, such as "escalate" or "exit", which triggers an EndSession signal with corresponding metadata to terminate the conversation.
+ "supportedLanguageCodes": [ # Optional. List of languages codes supported by the app, in addition to the `default_language_code`.
+ "A String",
+ ],
+ },
+ "locked": True or False, # Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected.
+ "loggingSettings": { # Settings to describe the logging behaviors for the app. # Optional. Logging settings of the app.
+ "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. The audio is subject to redaction as configured in RedactionConfig.
+ "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used.
+ },
+ "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The conversation data is subject to redaction as configured in RedactionConfig.
+ "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to.
+ "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled.
+ "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ },
+ "cloudLoggingSettings": { # Settings to describe the Cloud Logging behaviors for the app. # Optional. Settings to describe the Cloud Logging behaviors for the app.
+ "enableCloudLogging": True or False, # Optional. Whether to enable Cloud Logging for the sessions.
+ },
+ "conversationLoggingSettings": { # Settings to describe the conversation logging behaviors for the app. # Optional. Settings to describe the conversation logging behaviors for the app.
+ "disableConversationLogging": True or False, # Optional. Whether to disable conversation logging for the sessions.
+ "retentionWindow": "A String", # Optional. Controls the retention window for the conversation. If not set, the conversation will be retained for 365 days.
+ },
+ "evaluationAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded for the evaluation. By default, audio recording is not enabled for evaluation sessions.
+ "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used.
+ },
+ "metricAnalysisSettings": { # Settings to describe the conversation data collection behaviors for LLM analysis metrics pipeline. # Optional. Settings to describe the conversation data collection behaviors for the LLM analysis pipeline for the app.
+ "llmMetricsOptedOut": True or False, # Optional. Whether to collect conversation data for llm analysis metrics. If true, conversation data will not be collected for llm analysis metrics; otherwise, conversation data will be collected.
+ },
+ "redactionConfig": { # Configuration to instruct how sensitive data should be handled. # Optional. Configuration for how sensitive data should be redacted.
+ "deidentifyTemplate": "A String", # Optional. [DLP](https://cloud.google.com/dlp/docs) deidentify template name to instruct on how to de-identify content. Format: `projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template}`
+ "enableRedaction": True or False, # Optional. If true, redaction will be applied in various logging scenarios, including conversation history, Cloud Logging and audio recording.
+ "inspectTemplate": "A String", # Optional. [DLP](https://cloud.google.com/dlp/docs) inspect template name to configure detection of sensitive data types. Format: `projects/{project}/locations/{location}/inspectTemplates/{inspect_template}`
+ },
+ "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures an additional recording of unredacted audio. This can be used to maintain a raw audio copy when audio redaction is enabled, typically for auditing or monitoring purposes.
+ "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used.
+ },
+ "unredactedBigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The unredacted conversation data will be exported to BigQuery tables if it is enabled.
+ "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to.
+ "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled.
+ "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ },
+ },
+ "metadata": { # Optional. Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages.
+ "a_key": "A String",
+ },
+ "modelSettings": { # Model settings contains various configurations for the LLM model. # Optional. The default LLM model settings for the app. Individual resources (e.g. agents, guardrails) can override these configurations as needed.
+ "model": "A String", # Optional. The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
+ "temperature": 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
+ },
+ "name": "A String", # Identifier. The unique identifier of the app. Format: `projects/{project}/locations/{location}/apps/{app}`
+ "pinned": True or False, # Optional. Whether the app is pinned in the app list.
+ "predefinedVariableDeclarations": [ # Output only. The declarations of predefined variables for the app.
+ { # Defines the structure and metadata for a variable.
+ "description": "A String", # Required. The description of the variable.
+ "name": "A String", # Required. The name of the variable. The name must start with a letter or underscore and contain only letters, numbers, or underscores.
+ "schema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Required. The schema of the variable.
+ "additionalProperties": # Object with schema name: Schema # 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: Schema
+ ],
+ "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: Schema
+ },
+ "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",
+ ],
+ "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
+ "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+ "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
+ "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+ "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
+ "nullable": True or False, # Optional. Indicates if the value may be null.
+ "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY.
+ # Object with schema name: Schema
+ ],
+ "properties": { # Optional. Properties of Type.OBJECT.
+ "a_key": # Object with schema name: Schema
+ },
+ "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", # Required. The type of the data.
+ "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
+ },
+ },
+ ],
+ "rootAgent": "A String", # Optional. The root agent is the entry point of the app. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
+ "timeZoneSettings": { # TimeZone settings of the app. # Optional. TimeZone settings of the app.
+ "timeZone": "A String", # Optional. The time zone of the app from the [time zone database](https://www.iana.org/time-zones), e.g., America/Los_Angeles, Europe/Paris.
+ },
+ "toolExecutionMode": "A String", # Optional. The tool execution mode for the app. If not provided, will default to PARALLEL.
+ "updateTime": "A String", # Output only. Timestamp when the app was last updated.
+ "validationErrors": [ # Output only. Misconfigurations or warnings in the app.
+ "A String",
+ ],
+ "variableDeclarations": [ # Optional. The declarations of the variables.
+ { # Defines the structure and metadata for a variable.
+ "description": "A String", # Required. The description of the variable.
+ "name": "A String", # Required. The name of the variable. The name must start with a letter or underscore and contain only letters, numbers, or underscores.
+ "schema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Required. The schema of the variable.
+ "additionalProperties": # Object with schema name: Schema # 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: Schema
+ ],
+ "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: Schema
+ },
+ "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",
+ ],
+ "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
+ "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+ "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
+ "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+ "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
+ "nullable": True or False, # Optional. Indicates if the value may be null.
+ "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY.
+ # Object with schema name: Schema
+ ],
+ "properties": { # Optional. Properties of Type.OBJECT.
+ "a_key": # Object with schema name: Schema
+ },
+ "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", # Required. The type of the data.
+ "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
+ },
+ },
+ ],
+ "vpcScSettings": { # VPC-SC settings for the app. # Optional. VPC-SC settings for the app.
+ "allowedOrigins": [ # Optional. The allowed HTTP(s) origins that OpenAPI tools in the App are able to directly call when VPC Service Controls are enabled. These strings must match the origin exactly, including the port if specified. For example, "https://example.com" or "https://example.com:443". This list does not yet apply to Python tools that may make direct HTTP calls.
+ "A String",
+ ],
+ },
+ },
+ "examples": [ # Optional. List of examples in the app.
+ { # An example represents a sample conversation between the user and the agent(s).
+ "createTime": "A String", # Output only. Timestamp when the example was created.
+ "description": "A String", # Optional. Human-readable description of the example.
+ "displayName": "A String", # Required. Display name of the example.
+ "entryAgent": "A String", # Optional. The agent that initially handles the conversation. If not specified, the example represents a conversation that is handled by the root agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
+ "etag": "A String", # Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
+ "invalid": True or False, # Output only. The example may become invalid if referencing resources are deleted. Invalid examples will not be used as few-shot examples.
+ "messages": [ # Optional. The collection of messages that make up the conversation.
+ { # A message within a conversation.
+ "chunks": [ # Optional. Content of the message as a series of chunks.
+ { # A chunk of content within a message.
+ "agentTransfer": { # Represents an event indicating the transfer of a conversation to a different agent. # Optional. Agent transfer event.
+ "displayName": "A String", # Output only. Display name of the agent.
+ "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
+ },
+ "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data.
+ "data": "A String", # Required. Raw bytes of the blob.
+ "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+ },
+ "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names.
+ "a_key": "", # Properties of the object.
+ },
+ "image": { # Represents an image input or output in the conversation. # Optional. Image data.
+ "altText": "A String", # Optional. The alternative text for the image.
+ "data": "A String", # Required. Raw bytes of the image.
+ "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp
+ },
+ "payload": { # Optional. Custom payload data.
+ "a_key": "", # Properties of the object.
+ },
+ "text": "A String", # Optional. Text data.
+ "toolCall": { # Request for the client or the agent to execute the specified tool. # Optional. Tool execution request.
+ "agentName": "A String", # Output only. Human-readable name of the agent that issued this call, e.g. "Contract Architect". Empty when the root agent issued it.
+ "args": { # Optional. The input parameters and values for the tool in JSON object format.
+ "a_key": "", # Properties of the object.
+ },
+ "displayName": "A String", # Output only. Display name of the tool.
+ "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse.
+ "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling.
+ "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
+ "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute.
+ "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for.
+ "toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
+ },
+ },
+ "toolResponse": { # The execution result of a specific tool from the client or the agent. # Optional. Tool execution response.
+ "agentName": "A String", # Output only. Human-readable name of the agent that issued this call, e.g. "Contract Architect". Empty when the root agent issued it.
+ "displayName": "A String", # Output only. Display name of the tool.
+ "id": "A String", # Optional. The matching ID of the tool call the response is for.
+ "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling.
+ "response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result.
+ "a_key": "", # Properties of the object.
+ },
+ "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
+ "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed.
+ "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for.
+ "toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
+ },
+ },
+ "transcript": "A String", # Optional. Transcript associated with the audio.
+ "updatedVariables": { # A struct represents variables that were updated in the conversation, keyed by variable names.
+ "a_key": "", # Properties of the object.
+ },
+ },
+ ],
+ "eventTime": "A String", # Optional. Timestamp when the message was sent or received. Should not be used if the message is part of an example.
+ "role": "A String", # Optional. The role within the conversation, e.g., user, agent.
+ },
+ ],
+ "name": "A String", # Identifier. The unique identifier of the example. Format: `projects/{project}/locations/{location}/apps/{app}/examples/{example}`
+ "updateTime": "A String", # Output only. Timestamp when the example was last updated.
+ },
+ ],
+ "guardrails": [ # Optional. List of guardrails in the app.
+ { # Guardrail contains a list of checks and balances to keep the agents safe and secure.
+ "action": { # Action that is taken when a certain precondition is met. # Optional. Action to take when the guardrail is triggered.
+ "generativeAnswer": { # The agent will immediately respond with a generative answer. # Optional. Respond with a generative answer.
+ "prompt": "A String", # Required. The prompt to use for the generative answer.
+ },
+ "respondImmediately": { # The agent will immediately respond with a preconfigured response. # Optional. Immediately respond with a preconfigured response.
+ "responses": [ # Required. The canned responses for the agent to choose from. The response is chosen randomly.
+ { # Represents a response from the agent.
+ "disabled": True or False, # Optional. Whether the response is disabled. Disabled responses are not used by the agent.
+ "text": "A String", # Required. Text for the agent to respond with.
+ },
+ ],
+ },
+ "transferAgent": { # The agent will transfer the conversation to a different agent. # Optional. Transfer the conversation to a different agent.
+ "agent": "A String", # Required. The name of the agent to transfer the conversation to. The agent must be in the same app as the current agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
+ },
+ },
+ "codeCallback": { # Guardrail that blocks the conversation based on the code callbacks provided. # Optional. Guardrail that potentially blocks the conversation based on the result of the callback execution.
+ "afterAgentCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute after the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
+ "description": "A String", # Optional. Human-readable description of the callback.
+ "disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
+ "pythonCode": "A String", # Required. The python code to execute for the callback.
+ },
+ "afterModelCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute after the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
+ "description": "A String", # Optional. Human-readable description of the callback.
+ "disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
+ "pythonCode": "A String", # Required. The python code to execute for the callback.
+ },
+ "beforeAgentCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute before the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
+ "description": "A String", # Optional. Human-readable description of the callback.
+ "disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
+ "pythonCode": "A String", # Required. The python code to execute for the callback.
+ },
+ "beforeModelCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute before the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
+ "description": "A String", # Optional. Human-readable description of the callback.
+ "disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
+ "pythonCode": "A String", # Required. The python code to execute for the callback.
+ },
+ },
+ "contentFilter": { # Guardrail that bans certain content from being used in the conversation. # Optional. Guardrail that bans certain content from being used in the conversation.
+ "bannedContents": [ # Optional. List of banned phrases. Applies to both user inputs and agent responses.
+ "A String",
+ ],
+ "bannedContentsInAgentResponse": [ # Optional. List of banned phrases. Applies only to agent responses.
+ "A String",
+ ],
+ "bannedContentsInUserInput": [ # Optional. List of banned phrases. Applies only to user inputs.
+ "A String",
+ ],
+ "disregardDiacritics": True or False, # Optional. If true, diacritics are ignored during matching.
+ "matchType": "A String", # Required. Match type for the content filter.
+ },
+ "createTime": "A String", # Output only. Timestamp when the guardrail was created.
+ "description": "A String", # Optional. Description of the guardrail.
+ "displayName": "A String", # Required. Display name of the guardrail.
+ "enabled": True or False, # Optional. Whether the guardrail is enabled.
+ "etag": "A String", # Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
+ "llmPolicy": { # Guardrail that blocks the conversation if the LLM response is considered violating the policy based on the LLM classification. # Optional. Guardrail that blocks the conversation if the LLM response is considered violating the policy based on the LLM classification.
+ "allowShortUtterance": True or False, # Optional. By default, the LLM policy check is bypassed for short utterances. Enabling this setting applies the policy check to all utterances, including those that would normally be skipped.
+ "failOpen": True or False, # Optional. If an error occurs during the policy check, fail open and do not trigger the guardrail.
+ "maxConversationMessages": 42, # Optional. When checking this policy, consider the last 'n' messages in the conversation. When not set a default value of 10 will be used.
+ "modelSettings": { # Model settings contains various configurations for the LLM model. # Optional. Model settings.
+ "model": "A String", # Optional. The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
+ "temperature": 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
+ },
+ "policyScope": "A String", # Required. Defines when to apply the policy check during the conversation. If set to `POLICY_SCOPE_UNSPECIFIED`, the policy will be applied to the user input. When applying the policy to the agent response, additional latency will be introduced before the agent can respond.
+ "prompt": "A String", # Required. Policy prompt.
+ },
+ "llmPromptSecurity": { # Guardrail that blocks the conversation if the input is considered unsafe based on the LLM classification. # Optional. Guardrail that blocks the conversation if the prompt is considered unsafe based on the LLM classification.
+ "customPolicy": { # Guardrail that blocks the conversation if the LLM response is considered violating the policy based on the LLM classification. # Optional. Use a user-defined LlmPolicy to configure the security guardrail.
+ "allowShortUtterance": True or False, # Optional. By default, the LLM policy check is bypassed for short utterances. Enabling this setting applies the policy check to all utterances, including those that would normally be skipped.
+ "failOpen": True or False, # Optional. If an error occurs during the policy check, fail open and do not trigger the guardrail.
+ "maxConversationMessages": 42, # Optional. When checking this policy, consider the last 'n' messages in the conversation. When not set a default value of 10 will be used.
+ "modelSettings": { # Model settings contains various configurations for the LLM model. # Optional. Model settings.
+ "model": "A String", # Optional. The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
+ "temperature": 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
+ },
+ "policyScope": "A String", # Required. Defines when to apply the policy check during the conversation. If set to `POLICY_SCOPE_UNSPECIFIED`, the policy will be applied to the user input. When applying the policy to the agent response, additional latency will be introduced before the agent can respond.
+ "prompt": "A String", # Required. Policy prompt.
+ },
+ "defaultSettings": { # Configuration for default system security settings. # Optional. Use the system's predefined default security settings. To select this mode, include an empty 'default_settings' message in the request. The 'default_prompt_template' field within will be populated by the server in the response.
+ "defaultPromptTemplate": "A String", # Output only. The default prompt template used by the system. This field is for display purposes to show the user what prompt the system uses by default. It is OUTPUT_ONLY.
+ },
+ "failOpen": True or False, # Optional. Determines the behavior when the guardrail encounters an LLM error. - If true: the guardrail is bypassed. - If false (default): the guardrail triggers/blocks. Note: If a custom policy is provided, this field is ignored in favor of the policy's 'fail_open' configuration.
+ },
+ "modelSafety": { # Model safety settings overrides. When this is set, it will override the default settings and trigger the guardrail if the response is considered unsafe. # Optional. Guardrail that blocks the conversation if the LLM response is considered unsafe based on the model safety settings.
+ "safetySettings": [ # Required. List of safety settings.
+ { # Safety setting.
+ "category": "A String", # Required. The harm category.
+ "threshold": "A String", # Required. The harm block threshold.
+ },
+ ],
+ },
+ "name": "A String", # Identifier. The unique identifier of the guardrail. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`
+ "updateTime": "A String", # Output only. Timestamp when the guardrail was last updated.
+ },
+ ],
+ "tools": [ # Optional. List of tools in the app.
+ { # A tool represents an action that the CES agent can take to achieve certain goals.
+ "agentTool": { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool.
+ "agent": "A String", # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}`
+ "description": "A String", # Optional. Description of the tool's purpose.
+ "name": "A String", # Required. The name of the agent tool.
+ },
+ "clientFunction": { # Represents a client-side function that the agent can invoke. When the tool is chosen by the agent, control is handed off to the client. The client is responsible for executing the function and returning the result as a ToolResponse to continue the interaction with the agent. # Optional. The client function.
+ "description": "A String", # Optional. The function description.
+ "name": "A String", # Required. The function name.
+ "parameters": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the function parameters.
+ "additionalProperties": # Object with schema name: Schema # 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: Schema
+ ],
+ "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: Schema
+ },
+ "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",
+ ],
+ "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
+ "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+ "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
+ "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+ "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
+ "nullable": True or False, # Optional. Indicates if the value may be null.
+ "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY.
+ # Object with schema name: Schema
+ ],
+ "properties": { # Optional. Properties of Type.OBJECT.
+ "a_key": # Object with schema name: Schema
+ },
+ "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", # Required. The type of the data.
+ "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
+ },
+ "response": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the function response.
+ "additionalProperties": # Object with schema name: Schema # 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: Schema
+ ],
+ "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: Schema
+ },
+ "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",
+ ],
+ "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
+ "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+ "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
+ "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+ "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
+ "nullable": True or False, # Optional. Indicates if the value may be null.
+ "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY.
+ # Object with schema name: Schema
+ ],
+ "properties": { # Optional. Properties of Type.OBJECT.
+ "a_key": # Object with schema name: Schema
+ },
+ "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", # Required. The type of the data.
+ "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
+ },
+ },
+ "connectorTool": { # A ConnectorTool allows connections to different integrations. See: https://cloud.google.com/integration-connectors/docs/overview. # Optional. The Integration Connector tool.
+ "action": { # Configuration of an Action for the tool to use. Note: This can be either an Action or an Operation. See https://cloud.google.com/integration-connectors/docs/entities-operation-action for details. # Required. Action for the tool to use.
+ "connectionActionId": "A String", # ID of a Connection action for the tool to use.
+ "entityOperation": { # Entity CRUD operation specification. # Entity operation configuration for the tool to use.
+ "entityId": "A String", # Required. ID of the entity.
+ "operation": "A String", # Required. Operation to perform on the entity.
+ },
+ "inputFields": [ # Optional. Entity fields to use as inputs for the operation. If no fields are specified, all fields of the Entity will be used.
+ "A String",
+ ],
+ "outputFields": [ # Optional. Entity fields to return from the operation. If no fields are specified, all fields of the Entity will be returned.
+ "A String",
+ ],
+ },
+ "authConfig": { # End-user authentication configuration used for Connection calls. The field values must be the names of context variables in the format `$context.variables.`. # Optional. Configures how authentication is handled in Integration Connectors. By default, an admin authentication is passed in the Integration Connectors API requests. You can override it with a different end-user authentication config. **Note**: The Connection must have authentication override enabled in order to specify an EUC configuration here - otherwise, the ConnectorTool creation will fail. See https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override for details.
+ "oauth2AuthCodeConfig": { # Oauth 2.0 Authorization Code authentication configuration. # Oauth 2.0 Authorization Code authentication.
+ "oauthToken": "A String", # Required. Oauth token parameter name to pass through. Must be in the format `$context.variables.`.
+ },
+ "oauth2JwtBearerConfig": { # JWT Profile Oauth 2.0 Authorization Grant authentication configuration. # JWT Profile Oauth 2.0 Authorization Grant authentication.
+ "clientKey": "A String", # Required. Client parameter name to pass through. Must be in the format `$context.variables.`.
+ "issuer": "A String", # Required. Issuer parameter name to pass through. Must be in the format `$context.variables.`.
+ "subject": "A String", # Required. Subject parameter name to pass through. Must be in the format `$context.variables.`.
+ },
+ },
+ "connection": "A String", # Required. The full resource name of the referenced Integration Connectors Connection. Format: `projects/{project}/locations/{location}/connections/{connection}`
+ "description": "A String", # Optional. The description of the tool that can be used by the Agent to decide whether to call this ConnectorTool.
+ "name": "A String", # Optional. The name of the tool that can be used by the Agent to decide whether to call this ConnectorTool.
+ },
+ "createTime": "A String", # Output only. Timestamp when the tool was created.
+ "dataStoreTool": { # Tool to retrieve from Vertex AI Search datastore or engine for grounding. Accepts either a datastore or an engine, but not both. See Vertex AI Search: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction. # Optional. The data store tool.
+ "boostSpecs": [ # Optional. Boost specification to boost certain documents.
+ { # Boost specifications to boost certain documents. For more information, please refer to https://cloud.google.com/generative-ai-app-builder/docs/boosting.
+ "dataStores": [ # Required. The Data Store where the boosting configuration is applied. Full resource name of DataStore, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}.
+ "A String",
+ ],
+ "spec": [ # Required. A list of boosting specifications.
+ { # Boost specification to boost certain documents.
+ "conditionBoostSpecs": [ # Required. A list of boosting specifications.
+ { # Boost specification for a condition.
+ "boost": 3.14, # Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the suggestions a big promotion. However, it does not necessarily mean that the top result will be a boosted suggestion. Setting to -1.0 gives the suggestions a big demotion. However, other suggestions that are relevant might still be shown. Setting to 0.0 means no boost applied. The boosting condition is ignored.
+ "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Optional. Complex specification for custom ranking based on customer defined attribute value.
+ "attributeType": "A String", # Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).
+ "controlPoints": [ # Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.
+ { # The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).
+ "attributeValue": "A String", # Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.
+ "boostAmount": 3.14, # Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
+ },
+ ],
+ "fieldName": "A String", # Optional. The name of the field whose value will be used to determine the boost amount.
+ "interpolationType": "A String", # Optional. The interpolation type to be applied to connect the control points listed below.
+ },
+ "condition": "A String", # Required. An expression which specifies a boost condition. The syntax is the same as filter expression syntax. Currently, the only supported condition is a list of BCP-47 lang codes. Example: To boost suggestions in languages en or fr: (lang_code: ANY("en", "fr"))
+ },
+ ],
+ },
+ ],
+ },
+ ],
+ "dataStoreSource": { # Configuration for searching within a specific DataStore. # Optional. Search within a single specific DataStore.
+ "dataStore": { # A DataStore resource in Vertex AI Search. # Optional. The data store.
+ "connectorConfig": { # The connector config for the data store connection. # Output only. The connector config for the data store connection.
+ "collection": "A String", # Resource name of the collection the data store belongs to.
+ "collectionDisplayName": "A String", # Display name of the collection the data store belongs to.
+ "dataSource": "A String", # The name of the data source. Example: `salesforce`, `jira`, `confluence`, `bigquery`.
+ },
+ "createTime": "A String", # Output only. Timestamp when the data store was created.
+ "displayName": "A String", # Output only. The display name of the data store.
+ "documentProcessingMode": "A String", # Output only. The document processing mode for the data store connection. Only set for PUBLIC_WEB and UNSTRUCTURED data stores.
+ "name": "A String", # Required. Full resource name of the DataStore. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
+ "type": "A String", # Output only. The type of the data store. This field is readonly and populated by the server.
+ },
+ "filter": "A String", # Optional. Filter specification for the DataStore. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
+ },
+ "description": "A String", # Optional. The tool description.
+ "engineSource": { # Configuration for searching within an Engine, potentially targeting specific DataStores. # Optional. Search within an Engine (potentially across multiple DataStores).
+ "dataStoreSources": [ # Optional. Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine.
+ { # Configuration for searching within a specific DataStore.
+ "dataStore": { # A DataStore resource in Vertex AI Search. # Optional. The data store.
+ "connectorConfig": { # The connector config for the data store connection. # Output only. The connector config for the data store connection.
+ "collection": "A String", # Resource name of the collection the data store belongs to.
+ "collectionDisplayName": "A String", # Display name of the collection the data store belongs to.
+ "dataSource": "A String", # The name of the data source. Example: `salesforce`, `jira`, `confluence`, `bigquery`.
+ },
+ "createTime": "A String", # Output only. Timestamp when the data store was created.
+ "displayName": "A String", # Output only. The display name of the data store.
+ "documentProcessingMode": "A String", # Output only. The document processing mode for the data store connection. Only set for PUBLIC_WEB and UNSTRUCTURED data stores.
+ "name": "A String", # Required. Full resource name of the DataStore. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
+ "type": "A String", # Output only. The type of the data store. This field is readonly and populated by the server.
+ },
+ "filter": "A String", # Optional. Filter specification for the DataStore. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
+ },
+ ],
+ "engine": "A String", # Required. Full resource name of the Engine. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
+ "filter": "A String", # Optional. A filter applied to the search across the Engine. Not relevant and not used if 'data_store_sources' is provided. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
+ },
+ "filterParameterBehavior": "A String", # Optional. The filter parameter behavior.
+ "modalityConfigs": [ # Optional. The modality configs for the data store.
+ { # If specified, will apply the given configuration for the specified modality.
+ "groundingConfig": { # Grounding configuration. # Optional. The grounding configuration.
+ "disabled": True or False, # Optional. Whether grounding is disabled.
+ "groundingLevel": 3.14, # Optional. The groundedness threshold of the answer based on the retrieved sources. The value has a configurable range of [1, 5]. The level is used to threshold the groundedness of the answer, meaning that all responses with a groundedness score below the threshold will fall back to returning relevant snippets only. For example, a level of 3 means that the groundedness score must be 3 or higher for the response to be returned.
+ },
+ "modalityType": "A String", # Required. The modality type.
+ "rewriterConfig": { # Rewriter configuration. # Optional. The rewriter config.
+ "disabled": True or False, # Optional. Whether the rewriter is disabled.
+ "modelSettings": { # Model settings contains various configurations for the LLM model. # Required. Configurations for the LLM model.
+ "model": "A String", # Optional. The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
+ "temperature": 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
+ },
+ "prompt": "A String", # Optional. The prompt definition. If not set, default prompt will be used.
+ },
+ "snippetsConfig": { # Snippets configuration. # Optional. The snippets configuration.
+ "enableSnippets": True or False, # Optional. Whether snippets are enabled.
+ "maxSnippets": 42, # Optional. Number of snippets to return per query. If unset, returns all snippets from the service by default.
+ },
+ "summarizationConfig": { # Summarization configuration. # Optional. The summarization config.
+ "disabled": True or False, # Optional. Whether summarization is disabled.
+ "modelSettings": { # Model settings contains various configurations for the LLM model. # Optional. Configurations for the LLM model.
+ "model": "A String", # Optional. The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
+ "temperature": 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
+ },
+ "prompt": "A String", # Optional. The prompt definition. If not set, default prompt will be used.
+ },
+ },
+ ],
+ "name": "A String", # Required. The data store tool name.
+ },
+ "displayName": "A String", # Output only. The display name of the tool, derived based on the tool's type. For example, display name of a ClientFunction is derived from its `name` property.
+ "etag": "A String", # Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
+ "executionType": "A String", # Optional. The execution type of the tool.
+ "fileSearchTool": { # The file search tool allows the agent to search across the files uploaded by the app/agent developer. It has presets to give relatively good quality search over the uploaded files and summarization of the retrieved results. # Optional. The file search tool.
+ "corpusType": "A String", # Optional. The type of the corpus. Default is FULLY_MANAGED.
+ "description": "A String", # Optional. The tool description.
+ "fileCorpus": "A String", # Optional. The corpus where files are stored. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}
+ "name": "A String", # Required. The tool name.
+ },
+ "generatedSummary": "A String", # Output only. If the tool is generated by the LLM assistant, this field contains a descriptive summary of the generation.
+ "googleSearchTool": { # Represents a tool to perform Google web searches for grounding. See https://cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool#google-search. # Optional. The google search tool.
+ "contextUrls": [ # Optional. Content will be fetched directly from these URLs for context and grounding. Example: "https://example.com/path.html". A maximum of 20 URLs are allowed.
+ "A String",
+ ],
+ "description": "A String", # Optional. Description of the tool's purpose.
+ "excludeDomains": [ # Optional. List of domains to be excluded from the search results. Example: "example.com". A maximum of 2000 domains can be excluded.
+ "A String",
+ ],
+ "name": "A String", # Required. The name of the tool.
+ "preferredDomains": [ # Optional. Specifies domains to restrict search results to. Example: "example.com", "another.site". A maximum of 20 domains can be specified.
+ "A String",
+ ],
+ "promptConfig": { # Prompt settings used by the model when processing or summarizing the google search results. # Optional. Prompt instructions passed to planner on how the search results should be processed for text and voice.
+ "textPrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in chat conversations. If not set, default prompt will be used.
+ "voicePrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in voice conversations. If not set, default prompt will be used.
+ },
+ },
+ "mcpTool": { # An MCP tool. See https://modelcontextprotocol.io/specification/2025-06-18/server/tools for more details. # Optional. The MCP tool. An MCP tool cannot be created or updated directly and is managed by the MCP toolset.
+ "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required to execute the tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication.
+ "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth.
+ "apiKeySecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
+ "requestLocation": "A String", # Required. Key location in the request.
+ },
+ "bearerTokenConfig": { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth.
+ "token": "A String", # Required. The bearer token. Must be in the format `$context.variables.`.
+ },
+ "oauthConfig": { # Configurations for authentication with OAuth. # Optional. Config for OAuth.
+ "clientId": "A String", # Required. The client ID from the OAuth provider.
+ "clientSecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "oauthGrantType": "A String", # Required. OAuth grant types.
+ "scopes": [ # Optional. The OAuth scopes to grant.
+ "A String",
+ ],
+ "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
+ },
+ "serviceAccountAuthConfig": { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication.
+ "scopes": [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.
+ "A String",
+ ],
+ "serviceAccount": "A String", # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ },
+ "serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent.
+ },
+ },
+ "customHeaders": { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details.
+ "a_key": "A String",
+ },
+ "description": "A String", # Optional. The description of the MCP tool.
+ "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the input arguments of the MCP tool.
+ "additionalProperties": # Object with schema name: Schema # 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: Schema
+ ],
+ "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: Schema
+ },
+ "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",
+ ],
+ "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
+ "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+ "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
+ "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+ "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
+ "nullable": True or False, # Optional. Indicates if the value may be null.
+ "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY.
+ # Object with schema name: Schema
+ ],
+ "properties": { # Optional. Properties of Type.OBJECT.
+ "a_key": # Object with schema name: Schema
+ },
+ "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", # Required. The type of the data.
+ "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
+ },
+ "name": "A String", # Required. The name of the MCP tool.
+ "nameOverride": "A String", # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override.
+ "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool.
+ "additionalProperties": # Object with schema name: Schema # 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: Schema
+ ],
+ "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: Schema
+ },
+ "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",
+ ],
+ "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
+ "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+ "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
+ "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+ "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
+ "nullable": True or False, # Optional. Indicates if the value may be null.
+ "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY.
+ # Object with schema name: Schema
+ ],
+ "properties": { # Optional. Properties of Type.OBJECT.
+ "a_key": # Object with schema name: Schema
+ },
+ "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", # Required. The type of the data.
+ "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
+ },
+ "serverAddress": "A String", # Required. The server address of the MCP server, e.g., "https://example.com/mcp/". If the server is built with the MCP SDK, the url should be suffixed with "/mcp/". Only Streamable HTTP transport based servers are supported. This is the same as the server_address in the McpToolset. See https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http for more details.
+ "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter.
+ "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.
+ },
+ "state": "A String", # Output only. The dynamic availability state of the tool on the external server.
+ "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust.
+ "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
+ { # The CA certificate.
+ "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ```
+ "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
+ },
+ ],
+ },
+ },
+ "name": "A String", # Identifier. The resource name of the tool. Format: * `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for standalone tools. * `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only; they cannot be referenced directly where a tool is expected.
+ "openApiTool": { # A remote API tool defined by an OpenAPI schema. # Optional. The open API tool.
+ "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required by the API.
+ "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth.
+ "apiKeySecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
+ "requestLocation": "A String", # Required. Key location in the request.
+ },
+ "bearerTokenConfig": { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth.
+ "token": "A String", # Required. The bearer token. Must be in the format `$context.variables.`.
+ },
+ "oauthConfig": { # Configurations for authentication with OAuth. # Optional. Config for OAuth.
+ "clientId": "A String", # Required. The client ID from the OAuth provider.
+ "clientSecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "oauthGrantType": "A String", # Required. OAuth grant types.
+ "scopes": [ # Optional. The OAuth scopes to grant.
+ "A String",
+ ],
+ "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
+ },
+ "serviceAccountAuthConfig": { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication.
+ "scopes": [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.
+ "A String",
+ ],
+ "serviceAccount": "A String", # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ },
+ "serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent.
+ },
+ },
+ "description": "A String", # Optional. The description of the tool. If not provided, the description of the tool will be derived from the OpenAPI schema, from `operation.description` or `operation.summary`.
+ "ignoreUnknownFields": True or False, # Optional. If true, the agent will ignore unknown fields in the API response.
+ "name": "A String", # Optional. The name of the tool. If not provided, the name of the tool will be derived from the OpenAPI schema, from `operation.operationId`.
+ "openApiSchema": "A String", # Required. The OpenAPI schema in JSON or YAML format.
+ "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration.
+ "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.
+ },
+ "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client will trust.
+ "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
+ { # The CA certificate.
+ "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ```
+ "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
+ },
+ ],
+ },
+ "url": "A String", # Optional. The server URL of the Open API schema. This field is only set in tools in the environment dependencies during the export process if the schema contains a server url. During the import process, if this url is present in the environment dependencies and the schema has the $env_var placeholder, it will replace the placeholder in the schema.
+ },
+ "pythonFunction": { # A Python function tool. # Optional. The python function tool.
+ "description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring.
+ "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used.
+ "pythonCode": "A String", # Optional. The Python code to execute for the tool.
+ "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool.
+ "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.
+ },
+ },
+ "remoteAgentTool": { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool.
+ "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes.
+ "description": "A String", # Required. A description of the agent's domain of action/solution space.
+ "name": "A String", # Required. A human-readable name for the agent.
+ "skills": [ # Required. Skills represent a unit of ability an agent can perform. This may somewhat abstract but represents a more focused set of actions that the agent is highly likely to succeed at.
+ { # Represents a distinct capability or function that an agent can perform.
+ "description": "A String", # Required. A detailed description of the skill.
+ "examples": [ # Example prompts or scenarios that this skill can handle.
+ "A String",
+ ],
+ "id": "A String", # Required. A unique identifier for the agent's skill.
+ "inputModes": [ # The set of supported input media types for this skill, overriding the agent's defaults.
+ "A String",
+ ],
+ "name": "A String", # Required. A human-readable name for the skill.
+ "outputModes": [ # The set of supported output media types for this skill, overriding the agent's defaults.
+ "A String",
+ ],
+ "tags": [ # Required. A set of keywords describing the skill's capabilities.
+ "A String",
+ ],
+ },
+ ],
+ "supportedInterfaces": [ # Required. Ordered list of supported interfaces. The first entry is preferred.
+ { # Declares a combination of a target URL, transport and protocol version for interacting with the agent. This allows agents to expose the same functionality over multiple protocol binding mechanisms.
+ "protocolBinding": "A String", # Required. The protocol binding supported at this URL. This is an open form string, to be easily extended for other protocol bindings. The core ones officially supported are `JSONRPC`, `GRPC` and `HTTP+JSON`.
+ "protocolVersion": "A String", # Required. The version of the A2A protocol this interface exposes. Use the latest supported minor version per major version. Examples: "0.3", "1.0"
+ "tenant": "A String", # Tenant ID to be used in the request when calling the agent.
+ "url": "A String", # Required. The URL where this interface is available. Must be a valid absolute HTTPS URL in production. Example: "https://api.example.com/a2a/v1", "https://grpc.example.com/a2a"
+ },
+ ],
+ "version": "A String", # Required. The version of the agent.
+ },
+ "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication configuration for calling the remote agent.
+ "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth.
+ "apiKeySecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
+ "requestLocation": "A String", # Required. Key location in the request.
+ },
+ "bearerTokenConfig": { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth.
+ "token": "A String", # Required. The bearer token. Must be in the format `$context.variables.`.
+ },
+ "oauthConfig": { # Configurations for authentication with OAuth. # Optional. Config for OAuth.
+ "clientId": "A String", # Required. The client ID from the OAuth provider.
+ "clientSecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "oauthGrantType": "A String", # Required. OAuth grant types.
+ "scopes": [ # Optional. The OAuth scopes to grant.
+ "A String",
+ ],
+ "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
+ },
+ "serviceAccountAuthConfig": { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication.
+ "scopes": [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.
+ "A String",
+ ],
+ "serviceAccount": "A String", # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ },
+ "serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent.
+ },
+ },
+ "description": "A String", # Required. The description of the tool.
+ "name": "A String", # Required. The name of the tool.
+ },
+ "systemTool": { # Pre-defined system tool. # Optional. The system tool.
+ "description": "A String", # Output only. The description of the system tool.
+ "name": "A String", # Required. The name of the system tool.
+ },
+ "timeout": "A String", # Optional. The timeout for the tool execution. If not set, the default timeout is 30 seconds for `SYNCHRONOUS` tools and 60 seconds for `ASYNCHRONOUS` tools.
+ "toolFakeConfig": { # Configuration for tool behavior in fake mode. # Optional. Configuration for tool behavior in fake mode.
+ "codeBlock": { # A code block to be executed instead of a real tool call. # Optional. Code block which will be executed instead of a real tool call.
+ "pythonCode": "A String", # Required. Python code which will be invoked in tool fake mode. Expected Python function signature - To catch all tool calls: def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: To catch a specific tool call: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: If the function returns None, the real tool will be invoked instead.
+ },
+ "enableFakeMode": True or False, # Optional. Whether the tool is using fake mode.
+ },
+ "updateTime": "A String", # Output only. Timestamp when the tool was last updated.
+ "widgetTool": { # Represents a widget tool that the agent can invoke. When the tool is chosen by the agent, agent will return the widget to the client. The client is responsible for processing the widget and generating the next user query to continue the interaction with the agent. # Optional. The widget tool.
+ "dataMapping": { # Configuration for mapping data from a source tool to the widget's input parameters. # Optional. The mapping that defines how data from a source tool is mapped to the widget's input parameters.
+ "fieldMappings": { # Optional. A map of widget input parameter fields to the corresponding output fields of the source tool.
+ "a_key": "A String",
+ },
+ "mode": "A String", # Optional. The mode of the data mapping.
+ "pythonFunction": { # A Python function tool. # Optional. Configuration for a Python function used to transform the source tool's output into the widget's input format.
+ "description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring.
+ "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used.
+ "pythonCode": "A String", # Optional. The Python code to execute for the tool.
+ "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool.
+ "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.
+ },
+ },
+ "pythonScript": "A String", # Deprecated: Use `python_function` instead.
+ "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}`
+ },
+ "description": "A String", # Optional. The description of the widget tool.
+ "name": "A String", # Required. The display name of the widget tool.
+ "parameters": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The input parameters of the widget tool.
+ "additionalProperties": # Object with schema name: Schema # 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: Schema
+ ],
+ "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: Schema
+ },
+ "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",
+ ],
+ "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
+ "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+ "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
+ "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+ "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
+ "nullable": True or False, # Optional. Indicates if the value may be null.
+ "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY.
+ # Object with schema name: Schema
+ ],
+ "properties": { # Optional. Properties of Type.OBJECT.
+ "a_key": # Object with schema name: Schema
+ },
+ "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", # Required. The type of the data.
+ "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
+ },
+ "textResponseConfig": { # Configuration for the text response returned with the widget. # Optional. Configuration for always-included text responses.
+ "staticText": "A String", # Optional. The static text response to return when type is STATIC.
+ "textResponseInstruction": "A String", # Optional. Instruction for the LLM on how to generate the text response. Used as the description for the text response parameter if type is LLM_GENERATED.
+ "type": "A String", # Optional. The strategy for providing the text response.
+ },
+ "uiConfig": { # Optional. Configuration for rendering the widget.
+ "a_key": "", # Properties of the object.
+ },
+ "widgetType": "A String", # Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED.
+ },
+ },
+ ],
+ "toolsets": [ # Optional. List of toolsets in the app.
+ { # A toolset represents a group of dynamically managed tools that can be used by the agent.
+ "connectorToolset": { # A toolset that generates tools from an Integration Connectors Connection. # Optional. A toolset that generates tools from an Integration Connectors Connection.
+ "authConfig": { # End-user authentication configuration used for Connection calls. The field values must be the names of context variables in the format `$context.variables.`. # Optional. Configures how authentication is handled in Integration Connectors. By default, an admin authentication is passed in the Integration Connectors API requests. You can override it with a different end-user authentication config. **Note**: The Connection must have authentication override enabled in order to specify an EUC configuration here - otherwise, the Toolset creation will fail. See: https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override
+ "oauth2AuthCodeConfig": { # Oauth 2.0 Authorization Code authentication configuration. # Oauth 2.0 Authorization Code authentication.
+ "oauthToken": "A String", # Required. Oauth token parameter name to pass through. Must be in the format `$context.variables.`.
+ },
+ "oauth2JwtBearerConfig": { # JWT Profile Oauth 2.0 Authorization Grant authentication configuration. # JWT Profile Oauth 2.0 Authorization Grant authentication.
+ "clientKey": "A String", # Required. Client parameter name to pass through. Must be in the format `$context.variables.`.
+ "issuer": "A String", # Required. Issuer parameter name to pass through. Must be in the format `$context.variables.`.
+ "subject": "A String", # Required. Subject parameter name to pass through. Must be in the format `$context.variables.`.
+ },
+ },
+ "connection": "A String", # Required. The full resource name of the referenced Integration Connectors Connection. Format: `projects/{project}/locations/{location}/connections/{connection}`
+ "connectorActions": [ # Required. The list of connector actions/entity operations to generate tools for.
+ { # Configuration of an Action for the tool to use. Note: This can be either an Action or an Operation. See https://cloud.google.com/integration-connectors/docs/entities-operation-action for details.
+ "connectionActionId": "A String", # ID of a Connection action for the tool to use.
+ "entityOperation": { # Entity CRUD operation specification. # Entity operation configuration for the tool to use.
+ "entityId": "A String", # Required. ID of the entity.
+ "operation": "A String", # Required. Operation to perform on the entity.
+ },
+ "inputFields": [ # Optional. Entity fields to use as inputs for the operation. If no fields are specified, all fields of the Entity will be used.
+ "A String",
+ ],
+ "outputFields": [ # Optional. Entity fields to return from the operation. If no fields are specified, all fields of the Entity will be returned.
+ "A String",
+ ],
+ },
+ ],
+ },
+ "createTime": "A String", # Output only. Timestamp when the toolset was created.
+ "description": "A String", # Optional. The description of the toolset.
+ "displayName": "A String", # Optional. The display name of the toolset. Must be unique within the same app.
+ "etag": "A String", # ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
+ "executionType": "A String", # Optional. The execution type of the tools in the toolset.
+ "mcpToolset": { # A toolset that contains a list of tools that are offered by the MCP server. # Optional. A toolset that contains a list of tools that are offered by the MCP server.
+ "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required to access tools and execute a tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication.
+ "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth.
+ "apiKeySecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
+ "requestLocation": "A String", # Required. Key location in the request.
+ },
+ "bearerTokenConfig": { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth.
+ "token": "A String", # Required. The bearer token. Must be in the format `$context.variables.`.
+ },
+ "oauthConfig": { # Configurations for authentication with OAuth. # Optional. Config for OAuth.
+ "clientId": "A String", # Required. The client ID from the OAuth provider.
+ "clientSecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "oauthGrantType": "A String", # Required. OAuth grant types.
+ "scopes": [ # Optional. The OAuth scopes to grant.
+ "A String",
+ ],
+ "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
+ },
+ "serviceAccountAuthConfig": { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication.
+ "scopes": [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.
+ "A String",
+ ],
+ "serviceAccount": "A String", # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ },
+ "serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent.
+ },
+ },
+ "customHeaders": { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details.
+ "a_key": "A String",
+ },
+ "serverAddress": "A String", # Required. The address of the MCP server, for example, "https://example.com/mcp/". If the server is built with the MCP SDK, the url should be suffixed with "/mcp/". Only Streamable HTTP transport based servers are supported. See https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http for more details.
+ "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter.
+ "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.
+ },
+ "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust.
+ "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
+ { # The CA certificate.
+ "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ```
+ "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
+ },
+ ],
+ },
+ "toolOverrides": [ # Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic.
+ { # Overrides associated with a given tool in a Toolset. This enables "pinning" or "overriding" of tool definitions from the external dynamic server.
+ "descriptionOverride": "A String", # Optional. If present, this tool uses this description instead of the original description from the server.
+ "nameOverride": "A String", # Optional. If present, this tool uses this name in the Agent instead of the original name. This is primarily used as an alias if the MCP server offers poorly named tools.
+ "snapshot": { # Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden. # Output only. If present, this tool is "Pinned" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present.
+ "description": "A String", # Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`.
+ "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the input arguments of the MCP tool.
+ "additionalProperties": # Object with schema name: Schema # 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: Schema
+ ],
+ "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: Schema
+ },
+ "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",
+ ],
+ "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
+ "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+ "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
+ "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+ "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
+ "nullable": True or False, # Optional. Indicates if the value may be null.
+ "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY.
+ # Object with schema name: Schema
+ ],
+ "properties": { # Optional. Properties of Type.OBJECT.
+ "a_key": # Object with schema name: Schema
+ },
+ "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", # Required. The type of the data.
+ "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
+ },
+ "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the output arguments of the MCP tool.
+ "additionalProperties": # Object with schema name: Schema # 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: Schema
+ ],
+ "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: Schema
+ },
+ "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",
+ ],
+ "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
+ "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+ "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
+ "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+ "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
+ "nullable": True or False, # Optional. Indicates if the value may be null.
+ "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY.
+ # Object with schema name: Schema
+ ],
+ "properties": { # Optional. Properties of Type.OBJECT.
+ "a_key": # Object with schema name: Schema
+ },
+ "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", # Required. The type of the data.
+ "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
+ },
+ },
+ "tool": "A String", # Required. The original name of the tool as it is emitted by the MCP server.
+ },
+ ],
+ },
+ "name": "A String", # Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
+ "openApiToolset": { # A toolset that contains a list of tools that are defined by an OpenAPI schema. # Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema.
+ "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required by the API.
+ "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth.
+ "apiKeySecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
+ "requestLocation": "A String", # Required. Key location in the request.
+ },
+ "bearerTokenConfig": { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth.
+ "token": "A String", # Required. The bearer token. Must be in the format `$context.variables.`.
+ },
+ "oauthConfig": { # Configurations for authentication with OAuth. # Optional. Config for OAuth.
+ "clientId": "A String", # Required. The client ID from the OAuth provider.
+ "clientSecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "oauthGrantType": "A String", # Required. OAuth grant types.
+ "scopes": [ # Optional. The OAuth scopes to grant.
+ "A String",
+ ],
+ "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
+ },
+ "serviceAccountAuthConfig": { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication.
+ "scopes": [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.
+ "A String",
+ ],
+ "serviceAccount": "A String", # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ },
+ "serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent.
+ },
+ },
+ "ignoreUnknownFields": True or False, # Optional. If true, the agent will ignore unknown fields in the API response for all operations defined in the OpenAPI schema.
+ "openApiSchema": "A String", # Required. The OpenAPI schema of the toolset.
+ "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration.
+ "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.
+ },
+ "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates
+ "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
+ { # The CA certificate.
+ "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ```
+ "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
+ },
+ ],
+ },
+ "url": "A String", # Optional. The server URL of the Open API schema. This field is only set in toolsets in the environment dependencies during the export process if the schema contains a server url. During the import process, if this url is present in the environment dependencies and the schema has the $env_var placeholder, it will replace the placeholder in the schema.
+ },
+ "timeout": "A String", # Optional. The timeout for the toolset execution. If not set, the default timeout is 30 seconds for `SYNCHRONOUS` toolsets and 60 seconds for `ASYNCHRONOUS` toolsets.
+ "toolFakeConfig": { # Configuration for tool behavior in fake mode. # Optional. Configuration for tools behavior in fake mode.
+ "codeBlock": { # A code block to be executed instead of a real tool call. # Optional. Code block which will be executed instead of a real tool call.
+ "pythonCode": "A String", # Required. Python code which will be invoked in tool fake mode. Expected Python function signature - To catch all tool calls: def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: To catch a specific tool call: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: If the function returns None, the real tool will be invoked instead.
+ },
+ "enableFakeMode": True or False, # Optional. Whether the tool is using fake mode.
+ },
+ "updateTime": "A String", # Output only. Timestamp when the toolset was last updated.
+ },
+ ],
+ },
+ "updateTime": "A String", # Output only. Timestamp when the app version was last updated.
+}
+restore(name, body=None, x__xgafv=None)
Restores the specified app version. This will create a new app version from the current draft app and overwrite the current draft with the specified app version. diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.agents.html b/docs/dyn/ces_v1beta.projects.locations.apps.agents.html index 4becb5168d..8aedaaac42 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.agents.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.agents.html @@ -178,6 +178,78 @@Method Details
"temperature": 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative. }, "name": "A String", # Identifier. The unique identifier of the agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` + "remoteA2aAgent": { # The agent which will transfer execution to a remote [A2A](https://github.com/a2aproject/A2A) agent. # Optional. The remote [A2A](https://github.com/a2aproject/A2A) agent to be used for the agent execution. + "a2aConfig": { # Shared configuration for connecting to a remote [A2A](https://github.com/a2aproject/A2A) agent. # Required. The A2A connection configuration. + "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Optional. The full agent card defined inline. + "description": "A String", # Required. A description of the agent's domain of action/solution space. + "name": "A String", # Required. A human-readable name for the agent. + "skills": [ # Required. Skills represent a unit of ability an agent can perform. This may somewhat abstract but represents a more focused set of actions that the agent is highly likely to succeed at. + { # Represents a distinct capability or function that an agent can perform. + "description": "A String", # Required. A detailed description of the skill. + "examples": [ # Example prompts or scenarios that this skill can handle. + "A String", + ], + "id": "A String", # Required. A unique identifier for the agent's skill. + "inputModes": [ # The set of supported input media types for this skill, overriding the agent's defaults. + "A String", + ], + "name": "A String", # Required. A human-readable name for the skill. + "outputModes": [ # The set of supported output media types for this skill, overriding the agent's defaults. + "A String", + ], + "tags": [ # Required. A set of keywords describing the skill's capabilities. + "A String", + ], + }, + ], + "supportedInterfaces": [ # Required. Ordered list of supported interfaces. The first entry is preferred. + { # Declares a combination of a target URL, transport and protocol version for interacting with the agent. This allows agents to expose the same functionality over multiple protocol binding mechanisms. + "protocolBinding": "A String", # Required. The protocol binding supported at this URL. This is an open form string, to be easily extended for other protocol bindings. The core ones officially supported are `JSONRPC`, `GRPC` and `HTTP+JSON`. + "protocolVersion": "A String", # Required. The version of the A2A protocol this interface exposes. Use the latest supported minor version per major version. Examples: "0.3", "1.0" + "tenant": "A String", # Tenant ID to be used in the request when calling the agent. + "url": "A String", # Required. The URL where this interface is available. Must be a valid absolute HTTPS URL in production. Example: "https://api.example.com/a2a/v1", "https://grpc.example.com/a2a" + }, + ], + "version": "A String", # Required. The version of the agent. + }, + "agentRegistry": "A String", # Optional. Reference to the agent in the Agent Registry. Format: `projects/{project}/locations/{location}/agents/{agent}` + "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication configuration for calling the remote agent. Optional if the registry reference already handles authentication. + "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth. + "apiKeySecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. + "keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name. + "requestLocation": "A String", # Required. Key location in the request. + }, + "bearerTokenConfig": { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth. + "token": "A String", # Required. The bearer token. Must be in the format `$context.variables.`. + }, + "oauthConfig": { # Configurations for authentication with OAuth. # Optional. Config for OAuth. + "clientId": "A String", # Required. The client ID from the OAuth provider. + "clientSecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. + "oauthGrantType": "A String", # Required. OAuth grant types. + "scopes": [ # Optional. The OAuth scopes to grant. + "A String", + ], + "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token. + }, + "serviceAccountAuthConfig": { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication. + "scopes": [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used. + "A String", + ], + "serviceAccount": "A String", # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. + }, + "serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent. + }, + }, + "contextId": "A String", # Optional. If not empty, interactions with the remote A2A agent will use this context ID. This context_id field can refer to a session variable like `$context.variables.order_agent_session_id`. + "inputVariableMapping": { # Optional. Mapping of input variable names of remote agent to GECX variable names. + "a_key": "A String", + }, + "outputVariableMapping": { # Optional. Mapping of output variable names of remote agent to GECX variable names. + "a_key": "A String", + }, + "streamingEnabled": True or False, # Optional. Whether streaming is enabled for the remote agent. + }, + }, "remoteDialogflowAgent": { # The agent which will transfer execution to a remote [Dialogflow CX](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent. The Dialogflow agent will process subsequent user queries until the session ends or flow ends, and the control is transferred back to the parent CES agent. # Optional. The remote [Dialogflow](https://cloud.google.com/dialogflow/cx/docs/concept/console-conversational-agents) agent to be used for the agent execution. If this field is set, all other agent level properties will be ignored. Note: If the Dialogflow agent is in a different project from the app, you should grant `roles/dialogflow.client` to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "agent": "A String", # Required. The [Dialogflow](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent resource name. Format: `projects/{project}/locations/{location}/agents/{agent}` "environmentId": "A String", # Optional. The environment ID of the Dialogflow agent to be used for the agent execution. If not specified, the draft environment will be used. @@ -304,6 +376,78 @@Method Details
"temperature": 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative. }, "name": "A String", # Identifier. The unique identifier of the agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` + "remoteA2aAgent": { # The agent which will transfer execution to a remote [A2A](https://github.com/a2aproject/A2A) agent. # Optional. The remote [A2A](https://github.com/a2aproject/A2A) agent to be used for the agent execution. + "a2aConfig": { # Shared configuration for connecting to a remote [A2A](https://github.com/a2aproject/A2A) agent. # Required. The A2A connection configuration. + "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Optional. The full agent card defined inline. + "description": "A String", # Required. A description of the agent's domain of action/solution space. + "name": "A String", # Required. A human-readable name for the agent. + "skills": [ # Required. Skills represent a unit of ability an agent can perform. This may somewhat abstract but represents a more focused set of actions that the agent is highly likely to succeed at. + { # Represents a distinct capability or function that an agent can perform. + "description": "A String", # Required. A detailed description of the skill. + "examples": [ # Example prompts or scenarios that this skill can handle. + "A String", + ], + "id": "A String", # Required. A unique identifier for the agent's skill. + "inputModes": [ # The set of supported input media types for this skill, overriding the agent's defaults. + "A String", + ], + "name": "A String", # Required. A human-readable name for the skill. + "outputModes": [ # The set of supported output media types for this skill, overriding the agent's defaults. + "A String", + ], + "tags": [ # Required. A set of keywords describing the skill's capabilities. + "A String", + ], + }, + ], + "supportedInterfaces": [ # Required. Ordered list of supported interfaces. The first entry is preferred. + { # Declares a combination of a target URL, transport and protocol version for interacting with the agent. This allows agents to expose the same functionality over multiple protocol binding mechanisms. + "protocolBinding": "A String", # Required. The protocol binding supported at this URL. This is an open form string, to be easily extended for other protocol bindings. The core ones officially supported are `JSONRPC`, `GRPC` and `HTTP+JSON`. + "protocolVersion": "A String", # Required. The version of the A2A protocol this interface exposes. Use the latest supported minor version per major version. Examples: "0.3", "1.0" + "tenant": "A String", # Tenant ID to be used in the request when calling the agent. + "url": "A String", # Required. The URL where this interface is available. Must be a valid absolute HTTPS URL in production. Example: "https://api.example.com/a2a/v1", "https://grpc.example.com/a2a" + }, + ], + "version": "A String", # Required. The version of the agent. + }, + "agentRegistry": "A String", # Optional. Reference to the agent in the Agent Registry. Format: `projects/{project}/locations/{location}/agents/{agent}` + "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication configuration for calling the remote agent. Optional if the registry reference already handles authentication. + "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth. + "apiKeySecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. + "keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name. + "requestLocation": "A String", # Required. Key location in the request. + }, + "bearerTokenConfig": { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth. + "token": "A String", # Required. The bearer token. Must be in the format `$context.variables.`. + }, + "oauthConfig": { # Configurations for authentication with OAuth. # Optional. Config for OAuth. + "clientId": "A String", # Required. The client ID from the OAuth provider. + "clientSecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. + "oauthGrantType": "A String", # Required. OAuth grant types. + "scopes": [ # Optional. The OAuth scopes to grant. + "A String", + ], + "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token. + }, + "serviceAccountAuthConfig": { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication. + "scopes": [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used. + "A String", + ], + "serviceAccount": "A String", # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. + }, + "serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent. + }, + }, + "contextId": "A String", # Optional. If not empty, interactions with the remote A2A agent will use this context ID. This context_id field can refer to a session variable like `$context.variables.order_agent_session_id`. + "inputVariableMapping": { # Optional. Mapping of input variable names of remote agent to GECX variable names. + "a_key": "A String", + }, + "outputVariableMapping": { # Optional. Mapping of output variable names of remote agent to GECX variable names. + "a_key": "A String", + }, + "streamingEnabled": True or False, # Optional. Whether streaming is enabled for the remote agent. + }, + }, "remoteDialogflowAgent": { # The agent which will transfer execution to a remote [Dialogflow CX](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent. The Dialogflow agent will process subsequent user queries until the session ends or flow ends, and the control is transferred back to the parent CES agent. # Optional. The remote [Dialogflow](https://cloud.google.com/dialogflow/cx/docs/concept/console-conversational-agents) agent to be used for the agent execution. If this field is set, all other agent level properties will be ignored. Note: If the Dialogflow agent is in a different project from the app, you should grant `roles/dialogflow.client` to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "agent": "A String", # Required. The [Dialogflow](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent resource name. Format: `projects/{project}/locations/{location}/agents/{agent}` "environmentId": "A String", # Optional. The environment ID of the Dialogflow agent to be used for the agent execution. If not specified, the draft environment will be used. @@ -456,6 +600,78 @@Method Details
"temperature": 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative. }, "name": "A String", # Identifier. The unique identifier of the agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` + "remoteA2aAgent": { # The agent which will transfer execution to a remote [A2A](https://github.com/a2aproject/A2A) agent. # Optional. The remote [A2A](https://github.com/a2aproject/A2A) agent to be used for the agent execution. + "a2aConfig": { # Shared configuration for connecting to a remote [A2A](https://github.com/a2aproject/A2A) agent. # Required. The A2A connection configuration. + "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Optional. The full agent card defined inline. + "description": "A String", # Required. A description of the agent's domain of action/solution space. + "name": "A String", # Required. A human-readable name for the agent. + "skills": [ # Required. Skills represent a unit of ability an agent can perform. This may somewhat abstract but represents a more focused set of actions that the agent is highly likely to succeed at. + { # Represents a distinct capability or function that an agent can perform. + "description": "A String", # Required. A detailed description of the skill. + "examples": [ # Example prompts or scenarios that this skill can handle. + "A String", + ], + "id": "A String", # Required. A unique identifier for the agent's skill. + "inputModes": [ # The set of supported input media types for this skill, overriding the agent's defaults. + "A String", + ], + "name": "A String", # Required. A human-readable name for the skill. + "outputModes": [ # The set of supported output media types for this skill, overriding the agent's defaults. + "A String", + ], + "tags": [ # Required. A set of keywords describing the skill's capabilities. + "A String", + ], + }, + ], + "supportedInterfaces": [ # Required. Ordered list of supported interfaces. The first entry is preferred. + { # Declares a combination of a target URL, transport and protocol version for interacting with the agent. This allows agents to expose the same functionality over multiple protocol binding mechanisms. + "protocolBinding": "A String", # Required. The protocol binding supported at this URL. This is an open form string, to be easily extended for other protocol bindings. The core ones officially supported are `JSONRPC`, `GRPC` and `HTTP+JSON`. + "protocolVersion": "A String", # Required. The version of the A2A protocol this interface exposes. Use the latest supported minor version per major version. Examples: "0.3", "1.0" + "tenant": "A String", # Tenant ID to be used in the request when calling the agent. + "url": "A String", # Required. The URL where this interface is available. Must be a valid absolute HTTPS URL in production. Example: "https://api.example.com/a2a/v1", "https://grpc.example.com/a2a" + }, + ], + "version": "A String", # Required. The version of the agent. + }, + "agentRegistry": "A String", # Optional. Reference to the agent in the Agent Registry. Format: `projects/{project}/locations/{location}/agents/{agent}` + "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication configuration for calling the remote agent. Optional if the registry reference already handles authentication. + "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth. + "apiKeySecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. + "keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name. + "requestLocation": "A String", # Required. Key location in the request. + }, + "bearerTokenConfig": { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth. + "token": "A String", # Required. The bearer token. Must be in the format `$context.variables.`. + }, + "oauthConfig": { # Configurations for authentication with OAuth. # Optional. Config for OAuth. + "clientId": "A String", # Required. The client ID from the OAuth provider. + "clientSecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. + "oauthGrantType": "A String", # Required. OAuth grant types. + "scopes": [ # Optional. The OAuth scopes to grant. + "A String", + ], + "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token. + }, + "serviceAccountAuthConfig": { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication. + "scopes": [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used. + "A String", + ], + "serviceAccount": "A String", # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. + }, + "serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent. + }, + }, + "contextId": "A String", # Optional. If not empty, interactions with the remote A2A agent will use this context ID. This context_id field can refer to a session variable like `$context.variables.order_agent_session_id`. + "inputVariableMapping": { # Optional. Mapping of input variable names of remote agent to GECX variable names. + "a_key": "A String", + }, + "outputVariableMapping": { # Optional. Mapping of output variable names of remote agent to GECX variable names. + "a_key": "A String", + }, + "streamingEnabled": True or False, # Optional. Whether streaming is enabled for the remote agent. + }, + }, "remoteDialogflowAgent": { # The agent which will transfer execution to a remote [Dialogflow CX](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent. The Dialogflow agent will process subsequent user queries until the session ends or flow ends, and the control is transferred back to the parent CES agent. # Optional. The remote [Dialogflow](https://cloud.google.com/dialogflow/cx/docs/concept/console-conversational-agents) agent to be used for the agent execution. If this field is set, all other agent level properties will be ignored. Note: If the Dialogflow agent is in a different project from the app, you should grant `roles/dialogflow.client` to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "agent": "A String", # Required. The [Dialogflow](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent resource name. Format: `projects/{project}/locations/{location}/agents/{agent}` "environmentId": "A String", # Optional. The environment ID of the Dialogflow agent to be used for the agent execution. If not specified, the draft environment will be used. @@ -594,6 +810,78 @@Method Details
"temperature": 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative. }, "name": "A String", # Identifier. The unique identifier of the agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` + "remoteA2aAgent": { # The agent which will transfer execution to a remote [A2A](https://github.com/a2aproject/A2A) agent. # Optional. The remote [A2A](https://github.com/a2aproject/A2A) agent to be used for the agent execution. + "a2aConfig": { # Shared configuration for connecting to a remote [A2A](https://github.com/a2aproject/A2A) agent. # Required. The A2A connection configuration. + "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Optional. The full agent card defined inline. + "description": "A String", # Required. A description of the agent's domain of action/solution space. + "name": "A String", # Required. A human-readable name for the agent. + "skills": [ # Required. Skills represent a unit of ability an agent can perform. This may somewhat abstract but represents a more focused set of actions that the agent is highly likely to succeed at. + { # Represents a distinct capability or function that an agent can perform. + "description": "A String", # Required. A detailed description of the skill. + "examples": [ # Example prompts or scenarios that this skill can handle. + "A String", + ], + "id": "A String", # Required. A unique identifier for the agent's skill. + "inputModes": [ # The set of supported input media types for this skill, overriding the agent's defaults. + "A String", + ], + "name": "A String", # Required. A human-readable name for the skill. + "outputModes": [ # The set of supported output media types for this skill, overriding the agent's defaults. + "A String", + ], + "tags": [ # Required. A set of keywords describing the skill's capabilities. + "A String", + ], + }, + ], + "supportedInterfaces": [ # Required. Ordered list of supported interfaces. The first entry is preferred. + { # Declares a combination of a target URL, transport and protocol version for interacting with the agent. This allows agents to expose the same functionality over multiple protocol binding mechanisms. + "protocolBinding": "A String", # Required. The protocol binding supported at this URL. This is an open form string, to be easily extended for other protocol bindings. The core ones officially supported are `JSONRPC`, `GRPC` and `HTTP+JSON`. + "protocolVersion": "A String", # Required. The version of the A2A protocol this interface exposes. Use the latest supported minor version per major version. Examples: "0.3", "1.0" + "tenant": "A String", # Tenant ID to be used in the request when calling the agent. + "url": "A String", # Required. The URL where this interface is available. Must be a valid absolute HTTPS URL in production. Example: "https://api.example.com/a2a/v1", "https://grpc.example.com/a2a" + }, + ], + "version": "A String", # Required. The version of the agent. + }, + "agentRegistry": "A String", # Optional. Reference to the agent in the Agent Registry. Format: `projects/{project}/locations/{location}/agents/{agent}` + "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication configuration for calling the remote agent. Optional if the registry reference already handles authentication. + "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth. + "apiKeySecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. + "keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name. + "requestLocation": "A String", # Required. Key location in the request. + }, + "bearerTokenConfig": { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth. + "token": "A String", # Required. The bearer token. Must be in the format `$context.variables.`. + }, + "oauthConfig": { # Configurations for authentication with OAuth. # Optional. Config for OAuth. + "clientId": "A String", # Required. The client ID from the OAuth provider. + "clientSecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. + "oauthGrantType": "A String", # Required. OAuth grant types. + "scopes": [ # Optional. The OAuth scopes to grant. + "A String", + ], + "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token. + }, + "serviceAccountAuthConfig": { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication. + "scopes": [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used. + "A String", + ], + "serviceAccount": "A String", # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. + }, + "serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent. + }, + }, + "contextId": "A String", # Optional. If not empty, interactions with the remote A2A agent will use this context ID. This context_id field can refer to a session variable like `$context.variables.order_agent_session_id`. + "inputVariableMapping": { # Optional. Mapping of input variable names of remote agent to GECX variable names. + "a_key": "A String", + }, + "outputVariableMapping": { # Optional. Mapping of output variable names of remote agent to GECX variable names. + "a_key": "A String", + }, + "streamingEnabled": True or False, # Optional. Whether streaming is enabled for the remote agent. + }, + }, "remoteDialogflowAgent": { # The agent which will transfer execution to a remote [Dialogflow CX](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent. The Dialogflow agent will process subsequent user queries until the session ends or flow ends, and the control is transferred back to the parent CES agent. # Optional. The remote [Dialogflow](https://cloud.google.com/dialogflow/cx/docs/concept/console-conversational-agents) agent to be used for the agent execution. If this field is set, all other agent level properties will be ignored. Note: If the Dialogflow agent is in a different project from the app, you should grant `roles/dialogflow.client` to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "agent": "A String", # Required. The [Dialogflow](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent resource name. Format: `projects/{project}/locations/{location}/agents/{agent}` "environmentId": "A String", # Optional. The environment ID of the Dialogflow agent to be used for the agent execution. If not specified, the draft environment will be used. @@ -738,6 +1026,78 @@Method Details
"temperature": 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative. }, "name": "A String", # Identifier. The unique identifier of the agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` + "remoteA2aAgent": { # The agent which will transfer execution to a remote [A2A](https://github.com/a2aproject/A2A) agent. # Optional. The remote [A2A](https://github.com/a2aproject/A2A) agent to be used for the agent execution. + "a2aConfig": { # Shared configuration for connecting to a remote [A2A](https://github.com/a2aproject/A2A) agent. # Required. The A2A connection configuration. + "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Optional. The full agent card defined inline. + "description": "A String", # Required. A description of the agent's domain of action/solution space. + "name": "A String", # Required. A human-readable name for the agent. + "skills": [ # Required. Skills represent a unit of ability an agent can perform. This may somewhat abstract but represents a more focused set of actions that the agent is highly likely to succeed at. + { # Represents a distinct capability or function that an agent can perform. + "description": "A String", # Required. A detailed description of the skill. + "examples": [ # Example prompts or scenarios that this skill can handle. + "A String", + ], + "id": "A String", # Required. A unique identifier for the agent's skill. + "inputModes": [ # The set of supported input media types for this skill, overriding the agent's defaults. + "A String", + ], + "name": "A String", # Required. A human-readable name for the skill. + "outputModes": [ # The set of supported output media types for this skill, overriding the agent's defaults. + "A String", + ], + "tags": [ # Required. A set of keywords describing the skill's capabilities. + "A String", + ], + }, + ], + "supportedInterfaces": [ # Required. Ordered list of supported interfaces. The first entry is preferred. + { # Declares a combination of a target URL, transport and protocol version for interacting with the agent. This allows agents to expose the same functionality over multiple protocol binding mechanisms. + "protocolBinding": "A String", # Required. The protocol binding supported at this URL. This is an open form string, to be easily extended for other protocol bindings. The core ones officially supported are `JSONRPC`, `GRPC` and `HTTP+JSON`. + "protocolVersion": "A String", # Required. The version of the A2A protocol this interface exposes. Use the latest supported minor version per major version. Examples: "0.3", "1.0" + "tenant": "A String", # Tenant ID to be used in the request when calling the agent. + "url": "A String", # Required. The URL where this interface is available. Must be a valid absolute HTTPS URL in production. Example: "https://api.example.com/a2a/v1", "https://grpc.example.com/a2a" + }, + ], + "version": "A String", # Required. The version of the agent. + }, + "agentRegistry": "A String", # Optional. Reference to the agent in the Agent Registry. Format: `projects/{project}/locations/{location}/agents/{agent}` + "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication configuration for calling the remote agent. Optional if the registry reference already handles authentication. + "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth. + "apiKeySecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. + "keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name. + "requestLocation": "A String", # Required. Key location in the request. + }, + "bearerTokenConfig": { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth. + "token": "A String", # Required. The bearer token. Must be in the format `$context.variables.`. + }, + "oauthConfig": { # Configurations for authentication with OAuth. # Optional. Config for OAuth. + "clientId": "A String", # Required. The client ID from the OAuth provider. + "clientSecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. + "oauthGrantType": "A String", # Required. OAuth grant types. + "scopes": [ # Optional. The OAuth scopes to grant. + "A String", + ], + "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token. + }, + "serviceAccountAuthConfig": { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication. + "scopes": [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used. + "A String", + ], + "serviceAccount": "A String", # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. + }, + "serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent. + }, + }, + "contextId": "A String", # Optional. If not empty, interactions with the remote A2A agent will use this context ID. This context_id field can refer to a session variable like `$context.variables.order_agent_session_id`. + "inputVariableMapping": { # Optional. Mapping of input variable names of remote agent to GECX variable names. + "a_key": "A String", + }, + "outputVariableMapping": { # Optional. Mapping of output variable names of remote agent to GECX variable names. + "a_key": "A String", + }, + "streamingEnabled": True or False, # Optional. Whether streaming is enabled for the remote agent. + }, + }, "remoteDialogflowAgent": { # The agent which will transfer execution to a remote [Dialogflow CX](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent. The Dialogflow agent will process subsequent user queries until the session ends or flow ends, and the control is transferred back to the parent CES agent. # Optional. The remote [Dialogflow](https://cloud.google.com/dialogflow/cx/docs/concept/console-conversational-agents) agent to be used for the agent execution. If this field is set, all other agent level properties will be ignored. Note: If the Dialogflow agent is in a different project from the app, you should grant `roles/dialogflow.client` to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "agent": "A String", # Required. The [Dialogflow](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent resource name. Format: `projects/{project}/locations/{location}/agents/{agent}` "environmentId": "A String", # Optional. The environment ID of the Dialogflow agent to be used for the agent execution. If not specified, the draft environment will be used. @@ -864,6 +1224,78 @@Method Details
"temperature": 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative. }, "name": "A String", # Identifier. The unique identifier of the agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` + "remoteA2aAgent": { # The agent which will transfer execution to a remote [A2A](https://github.com/a2aproject/A2A) agent. # Optional. The remote [A2A](https://github.com/a2aproject/A2A) agent to be used for the agent execution. + "a2aConfig": { # Shared configuration for connecting to a remote [A2A](https://github.com/a2aproject/A2A) agent. # Required. The A2A connection configuration. + "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Optional. The full agent card defined inline. + "description": "A String", # Required. A description of the agent's domain of action/solution space. + "name": "A String", # Required. A human-readable name for the agent. + "skills": [ # Required. Skills represent a unit of ability an agent can perform. This may somewhat abstract but represents a more focused set of actions that the agent is highly likely to succeed at. + { # Represents a distinct capability or function that an agent can perform. + "description": "A String", # Required. A detailed description of the skill. + "examples": [ # Example prompts or scenarios that this skill can handle. + "A String", + ], + "id": "A String", # Required. A unique identifier for the agent's skill. + "inputModes": [ # The set of supported input media types for this skill, overriding the agent's defaults. + "A String", + ], + "name": "A String", # Required. A human-readable name for the skill. + "outputModes": [ # The set of supported output media types for this skill, overriding the agent's defaults. + "A String", + ], + "tags": [ # Required. A set of keywords describing the skill's capabilities. + "A String", + ], + }, + ], + "supportedInterfaces": [ # Required. Ordered list of supported interfaces. The first entry is preferred. + { # Declares a combination of a target URL, transport and protocol version for interacting with the agent. This allows agents to expose the same functionality over multiple protocol binding mechanisms. + "protocolBinding": "A String", # Required. The protocol binding supported at this URL. This is an open form string, to be easily extended for other protocol bindings. The core ones officially supported are `JSONRPC`, `GRPC` and `HTTP+JSON`. + "protocolVersion": "A String", # Required. The version of the A2A protocol this interface exposes. Use the latest supported minor version per major version. Examples: "0.3", "1.0" + "tenant": "A String", # Tenant ID to be used in the request when calling the agent. + "url": "A String", # Required. The URL where this interface is available. Must be a valid absolute HTTPS URL in production. Example: "https://api.example.com/a2a/v1", "https://grpc.example.com/a2a" + }, + ], + "version": "A String", # Required. The version of the agent. + }, + "agentRegistry": "A String", # Optional. Reference to the agent in the Agent Registry. Format: `projects/{project}/locations/{location}/agents/{agent}` + "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication configuration for calling the remote agent. Optional if the registry reference already handles authentication. + "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth. + "apiKeySecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. + "keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name. + "requestLocation": "A String", # Required. Key location in the request. + }, + "bearerTokenConfig": { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth. + "token": "A String", # Required. The bearer token. Must be in the format `$context.variables.`. + }, + "oauthConfig": { # Configurations for authentication with OAuth. # Optional. Config for OAuth. + "clientId": "A String", # Required. The client ID from the OAuth provider. + "clientSecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. + "oauthGrantType": "A String", # Required. OAuth grant types. + "scopes": [ # Optional. The OAuth scopes to grant. + "A String", + ], + "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token. + }, + "serviceAccountAuthConfig": { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication. + "scopes": [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used. + "A String", + ], + "serviceAccount": "A String", # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. + }, + "serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent. + }, + }, + "contextId": "A String", # Optional. If not empty, interactions with the remote A2A agent will use this context ID. This context_id field can refer to a session variable like `$context.variables.order_agent_session_id`. + "inputVariableMapping": { # Optional. Mapping of input variable names of remote agent to GECX variable names. + "a_key": "A String", + }, + "outputVariableMapping": { # Optional. Mapping of output variable names of remote agent to GECX variable names. + "a_key": "A String", + }, + "streamingEnabled": True or False, # Optional. Whether streaming is enabled for the remote agent. + }, + }, "remoteDialogflowAgent": { # The agent which will transfer execution to a remote [Dialogflow CX](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent. The Dialogflow agent will process subsequent user queries until the session ends or flow ends, and the control is transferred back to the parent CES agent. # Optional. The remote [Dialogflow](https://cloud.google.com/dialogflow/cx/docs/concept/console-conversational-agents) agent to be used for the agent execution. If this field is set, all other agent level properties will be ignored. Note: If the Dialogflow agent is in a different project from the app, you should grant `roles/dialogflow.client` to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "agent": "A String", # Required. The [Dialogflow](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent resource name. Format: `projects/{project}/locations/{location}/agents/{agent}` "environmentId": "A String", # Optional. The environment ID of the Dialogflow agent to be used for the agent execution. If not specified, the draft environment will be used. diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.conversations.html b/docs/dyn/ces_v1beta.projects.locations.apps.conversations.html index 4d2541ab6e..4dea022b3c 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.conversations.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.conversations.html @@ -260,6 +260,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -327,6 +328,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -449,6 +451,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -516,6 +519,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.deployments.html b/docs/dyn/ces_v1beta.projects.locations.apps.deployments.html index 4e406fba9f..a61a81a71d 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.deployments.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.deployments.html @@ -119,6 +119,9 @@Method Details
The object takes the form of: { # A deployment represents an immutable, queryable version of the app. It is used to deploy an app version with a specific channel profile. + "agentRegistryDeployment": { # Configuration and status for Agent Registry deployment. # Optional. Configuration for deploying this deployment to Agent Registry. If present, this deployment will be published to Agent Registry. + "agentRegistryServiceName": "A String", # Optional. Output only. The resource name of the deployed Agent Registry service. Format: `projects/{project}/locations/{location}/services/{service}` + }, "appVersion": "A String", # Optional. The resource name of the app version to deploy. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` Use `projects/{project}/locations/{location}/apps/{app}/versions/-` to use the draft app. "channelProfile": { # A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony. # Required. The channel profile used in the deployment. "channelType": "A String", # Optional. The type of the channel profile. @@ -203,6 +206,9 @@Method Details
An object of the form: { # A deployment represents an immutable, queryable version of the app. It is used to deploy an app version with a specific channel profile. + "agentRegistryDeployment": { # Configuration and status for Agent Registry deployment. # Optional. Configuration for deploying this deployment to Agent Registry. If present, this deployment will be published to Agent Registry. + "agentRegistryServiceName": "A String", # Optional. Output only. The resource name of the deployed Agent Registry service. Format: `projects/{project}/locations/{location}/services/{service}` + }, "appVersion": "A String", # Optional. The resource name of the app version to deploy. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` Use `projects/{project}/locations/{location}/apps/{app}/versions/-` to use the draft app. "channelProfile": { # A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony. # Required. The channel profile used in the deployment. "channelType": "A String", # Optional. The type of the channel profile. @@ -312,6 +318,9 @@Method Details
An object of the form: { # A deployment represents an immutable, queryable version of the app. It is used to deploy an app version with a specific channel profile. + "agentRegistryDeployment": { # Configuration and status for Agent Registry deployment. # Optional. Configuration for deploying this deployment to Agent Registry. If present, this deployment will be published to Agent Registry. + "agentRegistryServiceName": "A String", # Optional. Output only. The resource name of the deployed Agent Registry service. Format: `projects/{project}/locations/{location}/services/{service}` + }, "appVersion": "A String", # Optional. The resource name of the app version to deploy. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` Use `projects/{project}/locations/{location}/apps/{app}/versions/-` to use the draft app. "channelProfile": { # A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony. # Required. The channel profile used in the deployment. "channelType": "A String", # Optional. The type of the channel profile. @@ -578,6 +587,9 @@Method Details
{ # Response message for AgentService.ListDeployments. "deployments": [ # The list of deployments. { # A deployment represents an immutable, queryable version of the app. It is used to deploy an app version with a specific channel profile. + "agentRegistryDeployment": { # Configuration and status for Agent Registry deployment. # Optional. Configuration for deploying this deployment to Agent Registry. If present, this deployment will be published to Agent Registry. + "agentRegistryServiceName": "A String", # Optional. Output only. The resource name of the deployed Agent Registry service. Format: `projects/{project}/locations/{location}/services/{service}` + }, "appVersion": "A String", # Optional. The resource name of the app version to deploy. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` Use `projects/{project}/locations/{location}/apps/{app}/versions/-` to use the draft app. "channelProfile": { # A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony. # Required. The channel profile used in the deployment. "channelType": "A String", # Optional. The type of the channel profile. @@ -680,6 +692,9 @@Method Details
The object takes the form of: { # A deployment represents an immutable, queryable version of the app. It is used to deploy an app version with a specific channel profile. + "agentRegistryDeployment": { # Configuration and status for Agent Registry deployment. # Optional. Configuration for deploying this deployment to Agent Registry. If present, this deployment will be published to Agent Registry. + "agentRegistryServiceName": "A String", # Optional. Output only. The resource name of the deployed Agent Registry service. Format: `projects/{project}/locations/{location}/services/{service}` + }, "appVersion": "A String", # Optional. The resource name of the app version to deploy. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` Use `projects/{project}/locations/{location}/apps/{app}/versions/-` to use the draft app. "channelProfile": { # A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony. # Required. The channel profile used in the deployment. "channelType": "A String", # Optional. The type of the channel profile. @@ -764,6 +779,9 @@Method Details
An object of the form: { # A deployment represents an immutable, queryable version of the app. It is used to deploy an app version with a specific channel profile. + "agentRegistryDeployment": { # Configuration and status for Agent Registry deployment. # Optional. Configuration for deploying this deployment to Agent Registry. If present, this deployment will be published to Agent Registry. + "agentRegistryServiceName": "A String", # Optional. Output only. The resource name of the deployed Agent Registry service. Format: `projects/{project}/locations/{location}/services/{service}` + }, "appVersion": "A String", # Optional. The resource name of the app version to deploy. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` Use `projects/{project}/locations/{location}/apps/{app}/versions/-` to use the draft app. "channelProfile": { # A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony. # Required. The channel profile used in the deployment. "channelType": "A String", # Optional. The type of the channel profile. diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.html b/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.html index 7f3868cb7d..ec8ecfa75b 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.html @@ -283,6 +283,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -401,6 +402,7 @@Method Details
"event": "A String", # Required. The name of the event. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data from the end user. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -531,6 +533,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -653,6 +656,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -848,6 +852,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -938,6 +943,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -1167,6 +1173,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -1289,6 +1296,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -1484,6 +1492,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -1574,6 +1583,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -1739,6 +1749,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -2005,6 +2016,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -2123,6 +2135,7 @@Method Details
"event": "A String", # Required. The name of the event. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data from the end user. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -2253,6 +2266,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -2375,6 +2389,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -2570,6 +2585,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -2660,6 +2676,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -2889,6 +2906,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -3011,6 +3029,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -3206,6 +3225,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -3296,6 +3316,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -3461,6 +3482,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -3803,6 +3825,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -3921,6 +3944,7 @@Method Details
"event": "A String", # Required. The name of the event. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data from the end user. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -4051,6 +4075,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -4173,6 +4198,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -4368,6 +4394,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -4458,6 +4485,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -4687,6 +4715,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -4809,6 +4838,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -5004,6 +5034,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -5094,6 +5125,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -5259,6 +5291,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -5540,6 +5573,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -5658,6 +5692,7 @@Method Details
"event": "A String", # Required. The name of the event. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data from the end user. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -5788,6 +5823,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -5910,6 +5946,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -6105,6 +6142,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -6195,6 +6233,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -6424,6 +6463,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -6546,6 +6586,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -6741,6 +6782,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -6831,6 +6873,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -6996,6 +7039,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -7280,6 +7324,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -7398,6 +7443,7 @@Method Details
"event": "A String", # Required. The name of the event. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data from the end user. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -7528,6 +7574,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -7650,6 +7697,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -7845,6 +7893,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -7935,6 +7984,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -8164,6 +8214,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -8286,6 +8337,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -8481,6 +8533,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -8571,6 +8624,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -8736,6 +8790,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -9002,6 +9057,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -9120,6 +9176,7 @@Method Details
"event": "A String", # Required. The name of the event. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data from the end user. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -9250,6 +9307,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -9372,6 +9430,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -9567,6 +9626,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -9657,6 +9717,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -9886,6 +9947,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -10008,6 +10070,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -10203,6 +10266,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -10293,6 +10357,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -10458,6 +10523,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.results.html b/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.results.html index c36cc54764..a3cbc744ef 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.results.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.results.html @@ -273,6 +273,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -395,6 +396,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -590,6 +592,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -680,6 +683,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -930,6 +934,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -1052,6 +1057,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -1247,6 +1253,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -1337,6 +1344,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.examples.html b/docs/dyn/ces_v1beta.projects.locations.apps.examples.html index 5219004018..b53c1d8b9a 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.examples.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.examples.html @@ -133,6 +133,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -214,6 +215,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -320,6 +322,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -413,6 +416,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -512,6 +516,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -593,6 +598,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.html b/docs/dyn/ces_v1beta.projects.locations.apps.html index 2c9fe5a0ec..5629ee6415 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.html @@ -229,6 +229,16 @@Method Details
"bargeInAwareness": True or False, # Optional. If enabled, the agent will adapt its next response based on the assumption that the user hasn't heard the full preceding agent message. This should not be used in scenarios where agent responses are displayed visually. "disableBargeIn": True or False, # Optional. Deprecated: `disable_barge_in` is deprecated in favor of `disable_barge_in_control` in ChannelProfile. Disables user barge-in while the agent is speaking. If true, user input during agent response playback will be ignored. }, + "customVoiceSamples": [ # Optional. Configures custom voice samples for voice cloning. + { # Configuration for a custom voice sample used for voice cloning. + "consentAudioGcsUri": "A String", # Optional. Consent audio for voice cloning. + "name": "A String", # Optional. The user-defined name for the custom voice sample. + "previewAudioContent": "A String", # Output only. Synthesized preview audio for custom voice, formatted as canonical WAV (LINEAR16, 24kHz, 16-bit, mono). + "previewText": "A String", # Optional. Text for synthesizing preview audio for custom voice. + "voiceInstruction": "A String", # Optional. Natural language instructions for voice style, tone, pacing, or pronunciation. + "voiceSampleGcsUri": "A String", # Optional. The Cloud Storage URI to the audio sample for voice cloning. The audio sample should be a mono-channel, 24kHz WAV file. + }, + ], "inactivityTimeout": "A String", # Optional. The duration of user inactivity (no speech or interaction) before the agent prompts the user for reengagement. If not set, the agent will not prompt the user for reengagement. "synthesizeSpeechConfigs": { # Optional. Configuration of how the agent response should be synthesized, mapping from the language code to SynthesizeSpeechConfig. If the configuration for the specified language code is not found, the configuration for the root language code will be used. For example, if the map contains "en-us" and "en", and the specified language code is "en-gb", then "en" configuration will be used. Note: Language code is case-insensitive. "a_key": { # Configuration for how the agent response should be synthesized. @@ -657,6 +667,15 @@Method Details
"uri": "A String", # URI used for citation. }, ], + "inlineCitations": [ # Optional. List of inline citations in the agent response. + { # An inline citation in the response text. + "citedChunkIndices": [ # The indices of the cited chunks that back this text segment. Indices refer to the elements in `cited_chunks`. + 42, + ], + "endIndex": 42, # The ending index (in bytes) of the text segment in the agent response. + "startIndex": 42, # The starting index (in bytes) of the text segment in the agent response. + }, + ], }, "googleSearchSuggestions": { # Search suggestions from Google Search Tool. # The suggestions returned from Google Search as a result of invoking the Google Search Tool during the tool execution. "htmls": [ # Compliant HTML and CSS styling for search suggestions. The provided HTML and CSS automatically adapts to your device settings, displaying in either light or dark mode indicated by `@media(prefers-color-scheme)`. @@ -805,6 +824,78 @@Method Details
"temperature": 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative. }, "name": "A String", # Identifier. The unique identifier of the agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` + "remoteA2aAgent": { # The agent which will transfer execution to a remote [A2A](https://github.com/a2aproject/A2A) agent. # Optional. The remote [A2A](https://github.com/a2aproject/A2A) agent to be used for the agent execution. + "a2aConfig": { # Shared configuration for connecting to a remote [A2A](https://github.com/a2aproject/A2A) agent. # Required. The A2A connection configuration. + "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Optional. The full agent card defined inline. + "description": "A String", # Required. A description of the agent's domain of action/solution space. + "name": "A String", # Required. A human-readable name for the agent. + "skills": [ # Required. Skills represent a unit of ability an agent can perform. This may somewhat abstract but represents a more focused set of actions that the agent is highly likely to succeed at. + { # Represents a distinct capability or function that an agent can perform. + "description": "A String", # Required. A detailed description of the skill. + "examples": [ # Example prompts or scenarios that this skill can handle. + "A String", + ], + "id": "A String", # Required. A unique identifier for the agent's skill. + "inputModes": [ # The set of supported input media types for this skill, overriding the agent's defaults. + "A String", + ], + "name": "A String", # Required. A human-readable name for the skill. + "outputModes": [ # The set of supported output media types for this skill, overriding the agent's defaults. + "A String", + ], + "tags": [ # Required. A set of keywords describing the skill's capabilities. + "A String", + ], + }, + ], + "supportedInterfaces": [ # Required. Ordered list of supported interfaces. The first entry is preferred. + { # Declares a combination of a target URL, transport and protocol version for interacting with the agent. This allows agents to expose the same functionality over multiple protocol binding mechanisms. + "protocolBinding": "A String", # Required. The protocol binding supported at this URL. This is an open form string, to be easily extended for other protocol bindings. The core ones officially supported are `JSONRPC`, `GRPC` and `HTTP+JSON`. + "protocolVersion": "A String", # Required. The version of the A2A protocol this interface exposes. Use the latest supported minor version per major version. Examples: "0.3", "1.0" + "tenant": "A String", # Tenant ID to be used in the request when calling the agent. + "url": "A String", # Required. The URL where this interface is available. Must be a valid absolute HTTPS URL in production. Example: "https://api.example.com/a2a/v1", "https://grpc.example.com/a2a" + }, + ], + "version": "A String", # Required. The version of the agent. + }, + "agentRegistry": "A String", # Optional. Reference to the agent in the Agent Registry. Format: `projects/{project}/locations/{location}/agents/{agent}` + "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication configuration for calling the remote agent. Optional if the registry reference already handles authentication. + "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth. + "apiKeySecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. + "keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name. + "requestLocation": "A String", # Required. Key location in the request. + }, + "bearerTokenConfig": { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth. + "token": "A String", # Required. The bearer token. Must be in the format `$context.variables.`. + }, + "oauthConfig": { # Configurations for authentication with OAuth. # Optional. Config for OAuth. + "clientId": "A String", # Required. The client ID from the OAuth provider. + "clientSecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. + "oauthGrantType": "A String", # Required. OAuth grant types. + "scopes": [ # Optional. The OAuth scopes to grant. + "A String", + ], + "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token. + }, + "serviceAccountAuthConfig": { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication. + "scopes": [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used. + "A String", + ], + "serviceAccount": "A String", # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. + }, + "serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent. + }, + }, + "contextId": "A String", # Optional. If not empty, interactions with the remote A2A agent will use this context ID. This context_id field can refer to a session variable like `$context.variables.order_agent_session_id`. + "inputVariableMapping": { # Optional. Mapping of input variable names of remote agent to GECX variable names. + "a_key": "A String", + }, + "outputVariableMapping": { # Optional. Mapping of output variable names of remote agent to GECX variable names. + "a_key": "A String", + }, + "streamingEnabled": True or False, # Optional. Whether streaming is enabled for the remote agent. + }, + }, "remoteDialogflowAgent": { # The agent which will transfer execution to a remote [Dialogflow CX](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent. The Dialogflow agent will process subsequent user queries until the session ends or flow ends, and the control is transferred back to the parent CES agent. # Optional. The remote [Dialogflow](https://cloud.google.com/dialogflow/cx/docs/concept/console-conversational-agents) agent to be used for the agent execution. If this field is set, all other agent level properties will be ignored. Note: If the Dialogflow agent is in a different project from the app, you should grant `roles/dialogflow.client` to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "agent": "A String", # Required. The [Dialogflow](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent resource name. Format: `projects/{project}/locations/{location}/agents/{agent}` "environmentId": "A String", # Optional. The environment ID of the Dialogflow agent to be used for the agent execution. If not specified, the draft environment will be used. @@ -1738,6 +1829,16 @@Method Details
"bargeInAwareness": True or False, # Optional. If enabled, the agent will adapt its next response based on the assumption that the user hasn't heard the full preceding agent message. This should not be used in scenarios where agent responses are displayed visually. "disableBargeIn": True or False, # Optional. Deprecated: `disable_barge_in` is deprecated in favor of `disable_barge_in_control` in ChannelProfile. Disables user barge-in while the agent is speaking. If true, user input during agent response playback will be ignored. }, + "customVoiceSamples": [ # Optional. Configures custom voice samples for voice cloning. + { # Configuration for a custom voice sample used for voice cloning. + "consentAudioGcsUri": "A String", # Optional. Consent audio for voice cloning. + "name": "A String", # Optional. The user-defined name for the custom voice sample. + "previewAudioContent": "A String", # Output only. Synthesized preview audio for custom voice, formatted as canonical WAV (LINEAR16, 24kHz, 16-bit, mono). + "previewText": "A String", # Optional. Text for synthesizing preview audio for custom voice. + "voiceInstruction": "A String", # Optional. Natural language instructions for voice style, tone, pacing, or pronunciation. + "voiceSampleGcsUri": "A String", # Optional. The Cloud Storage URI to the audio sample for voice cloning. The audio sample should be a mono-channel, 24kHz WAV file. + }, + ], "inactivityTimeout": "A String", # Optional. The duration of user inactivity (no speech or interaction) before the agent prompts the user for reengagement. If not set, the agent will not prompt the user for reengagement. "synthesizeSpeechConfigs": { # Optional. Configuration of how the agent response should be synthesized, mapping from the language code to SynthesizeSpeechConfig. If the configuration for the specified language code is not found, the configuration for the root language code will be used. For example, if the map contains "en-us" and "en", and the specified language code is "en-gb", then "en" configuration will be used. Note: Language code is case-insensitive. "a_key": { # Configuration for how the agent response should be synthesized. @@ -2344,6 +2445,16 @@Method Details
"bargeInAwareness": True or False, # Optional. If enabled, the agent will adapt its next response based on the assumption that the user hasn't heard the full preceding agent message. This should not be used in scenarios where agent responses are displayed visually. "disableBargeIn": True or False, # Optional. Deprecated: `disable_barge_in` is deprecated in favor of `disable_barge_in_control` in ChannelProfile. Disables user barge-in while the agent is speaking. If true, user input during agent response playback will be ignored. }, + "customVoiceSamples": [ # Optional. Configures custom voice samples for voice cloning. + { # Configuration for a custom voice sample used for voice cloning. + "consentAudioGcsUri": "A String", # Optional. Consent audio for voice cloning. + "name": "A String", # Optional. The user-defined name for the custom voice sample. + "previewAudioContent": "A String", # Output only. Synthesized preview audio for custom voice, formatted as canonical WAV (LINEAR16, 24kHz, 16-bit, mono). + "previewText": "A String", # Optional. Text for synthesizing preview audio for custom voice. + "voiceInstruction": "A String", # Optional. Natural language instructions for voice style, tone, pacing, or pronunciation. + "voiceSampleGcsUri": "A String", # Optional. The Cloud Storage URI to the audio sample for voice cloning. The audio sample should be a mono-channel, 24kHz WAV file. + }, + ], "inactivityTimeout": "A String", # Optional. The duration of user inactivity (no speech or interaction) before the agent prompts the user for reengagement. If not set, the agent will not prompt the user for reengagement. "synthesizeSpeechConfigs": { # Optional. Configuration of how the agent response should be synthesized, mapping from the language code to SynthesizeSpeechConfig. If the configuration for the specified language code is not found, the configuration for the root language code will be used. For example, if the map contains "en-us" and "en", and the specified language code is "en-gb", then "en" configuration will be used. Note: Language code is case-insensitive. "a_key": { # Configuration for how the agent response should be synthesized. @@ -2685,6 +2796,16 @@Method Details
"bargeInAwareness": True or False, # Optional. If enabled, the agent will adapt its next response based on the assumption that the user hasn't heard the full preceding agent message. This should not be used in scenarios where agent responses are displayed visually. "disableBargeIn": True or False, # Optional. Deprecated: `disable_barge_in` is deprecated in favor of `disable_barge_in_control` in ChannelProfile. Disables user barge-in while the agent is speaking. If true, user input during agent response playback will be ignored. }, + "customVoiceSamples": [ # Optional. Configures custom voice samples for voice cloning. + { # Configuration for a custom voice sample used for voice cloning. + "consentAudioGcsUri": "A String", # Optional. Consent audio for voice cloning. + "name": "A String", # Optional. The user-defined name for the custom voice sample. + "previewAudioContent": "A String", # Output only. Synthesized preview audio for custom voice, formatted as canonical WAV (LINEAR16, 24kHz, 16-bit, mono). + "previewText": "A String", # Optional. Text for synthesizing preview audio for custom voice. + "voiceInstruction": "A String", # Optional. Natural language instructions for voice style, tone, pacing, or pronunciation. + "voiceSampleGcsUri": "A String", # Optional. The Cloud Storage URI to the audio sample for voice cloning. The audio sample should be a mono-channel, 24kHz WAV file. + }, + ], "inactivityTimeout": "A String", # Optional. The duration of user inactivity (no speech or interaction) before the agent prompts the user for reengagement. If not set, the agent will not prompt the user for reengagement. "synthesizeSpeechConfigs": { # Optional. Configuration of how the agent response should be synthesized, mapping from the language code to SynthesizeSpeechConfig. If the configuration for the specified language code is not found, the configuration for the root language code will be used. For example, if the map contains "en-us" and "en", and the specified language code is "en-gb", then "en" configuration will be used. Note: Language code is case-insensitive. "a_key": { # Configuration for how the agent response should be synthesized. @@ -3005,6 +3126,16 @@Method Details
"bargeInAwareness": True or False, # Optional. If enabled, the agent will adapt its next response based on the assumption that the user hasn't heard the full preceding agent message. This should not be used in scenarios where agent responses are displayed visually. "disableBargeIn": True or False, # Optional. Deprecated: `disable_barge_in` is deprecated in favor of `disable_barge_in_control` in ChannelProfile. Disables user barge-in while the agent is speaking. If true, user input during agent response playback will be ignored. }, + "customVoiceSamples": [ # Optional. Configures custom voice samples for voice cloning. + { # Configuration for a custom voice sample used for voice cloning. + "consentAudioGcsUri": "A String", # Optional. Consent audio for voice cloning. + "name": "A String", # Optional. The user-defined name for the custom voice sample. + "previewAudioContent": "A String", # Output only. Synthesized preview audio for custom voice, formatted as canonical WAV (LINEAR16, 24kHz, 16-bit, mono). + "previewText": "A String", # Optional. Text for synthesizing preview audio for custom voice. + "voiceInstruction": "A String", # Optional. Natural language instructions for voice style, tone, pacing, or pronunciation. + "voiceSampleGcsUri": "A String", # Optional. The Cloud Storage URI to the audio sample for voice cloning. The audio sample should be a mono-channel, 24kHz WAV file. + }, + ], "inactivityTimeout": "A String", # Optional. The duration of user inactivity (no speech or interaction) before the agent prompts the user for reengagement. If not set, the agent will not prompt the user for reengagement. "synthesizeSpeechConfigs": { # Optional. Configuration of how the agent response should be synthesized, mapping from the language code to SynthesizeSpeechConfig. If the configuration for the specified language code is not found, the configuration for the root language code will be used. For example, if the map contains "en-us" and "en", and the specified language code is "en-gb", then "en" configuration will be used. Note: Language code is case-insensitive. "a_key": { # Configuration for how the agent response should be synthesized. diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.sessions.html b/docs/dyn/ces_v1beta.projects.locations.apps.sessions.html index f52c5e0c6d..3aebad4b3e 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.sessions.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.sessions.html @@ -152,6 +152,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -232,6 +233,7 @@Method Details
"event": "A String", # Required. The name of the event. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data from the end user. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -283,6 +285,15 @@Method Details
"uri": "A String", # URI used for citation. }, ], + "inlineCitations": [ # Optional. List of inline citations in the agent response. + { # An inline citation in the response text. + "citedChunkIndices": [ # The indices of the cited chunks that back this text segment. Indices refer to the elements in `cited_chunks`. + 42, + ], + "endIndex": 42, # The ending index (in bytes) of the text segment in the agent response. + "startIndex": 42, # The starting index (in bytes) of the text segment in the agent response. + }, + ], }, "context": [ # Context messages for external supervision guardrails. { @@ -306,6 +317,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -381,12 +393,14 @@Method Details
], }, "image": { # Represents an image input or output in the conversation. # Output image from the CES agent. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, "payload": { # Custom payload with structured output from the CES agent. "a_key": "", # Properties of the object. }, + "progress": "A String", # Intermediate progress update from the CES agent. "text": "A String", # Output text from the CES agent. "toolCalls": { # Request for the client to execute the tools and return the execution results before continuing the session. # Request for the client to execute the tools. "toolCalls": [ # Optional. The list of tool calls to execute. @@ -444,6 +458,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -524,6 +539,7 @@Method Details
"event": "A String", # Required. The name of the event. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data from the end user. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -575,6 +591,15 @@Method Details
"uri": "A String", # URI used for citation. }, ], + "inlineCitations": [ # Optional. List of inline citations in the agent response. + { # An inline citation in the response text. + "citedChunkIndices": [ # The indices of the cited chunks that back this text segment. Indices refer to the elements in `cited_chunks`. + 42, + ], + "endIndex": 42, # The ending index (in bytes) of the text segment in the agent response. + "startIndex": 42, # The starting index (in bytes) of the text segment in the agent response. + }, + ], }, "context": [ # Context messages for external supervision guardrails. { @@ -598,6 +623,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -673,12 +699,14 @@Method Details
], }, "image": { # Represents an image input or output in the conversation. # Output image from the CES agent. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, "payload": { # Custom payload with structured output from the CES agent. "a_key": "", # Properties of the object. }, + "progress": "A String", # Intermediate progress update from the CES agent. "text": "A String", # Output text from the CES agent. "toolCalls": { # Request for the client to execute the tools and return the execution results before continuing the session. # Request for the client to execute the tools. "toolCalls": [ # Optional. The list of tool calls to execute. diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.versions.html b/docs/dyn/ces_v1beta.projects.locations.apps.versions.html index 9dba7e9fe6..866be2f5f3 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.versions.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.versions.html @@ -100,6 +100,9 @@Instance Methods
list_next(previous_request, previous_response)Retrieves the next page of results.
++
+patch(name, body=None, updateMask=None, x__xgafv=None)Updates the specified app version.
restore(name, body=None, x__xgafv=None)Restores the specified app version. This will create a new app version from the current draft app and overwrite the current draft with the specified app version.
@@ -195,6 +198,78 @@Method Details
"temperature": 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative. }, "name": "A String", # Identifier. The unique identifier of the agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` + "remoteA2aAgent": { # The agent which will transfer execution to a remote [A2A](https://github.com/a2aproject/A2A) agent. # Optional. The remote [A2A](https://github.com/a2aproject/A2A) agent to be used for the agent execution. + "a2aConfig": { # Shared configuration for connecting to a remote [A2A](https://github.com/a2aproject/A2A) agent. # Required. The A2A connection configuration. + "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Optional. The full agent card defined inline. + "description": "A String", # Required. A description of the agent's domain of action/solution space. + "name": "A String", # Required. A human-readable name for the agent. + "skills": [ # Required. Skills represent a unit of ability an agent can perform. This may somewhat abstract but represents a more focused set of actions that the agent is highly likely to succeed at. + { # Represents a distinct capability or function that an agent can perform. + "description": "A String", # Required. A detailed description of the skill. + "examples": [ # Example prompts or scenarios that this skill can handle. + "A String", + ], + "id": "A String", # Required. A unique identifier for the agent's skill. + "inputModes": [ # The set of supported input media types for this skill, overriding the agent's defaults. + "A String", + ], + "name": "A String", # Required. A human-readable name for the skill. + "outputModes": [ # The set of supported output media types for this skill, overriding the agent's defaults. + "A String", + ], + "tags": [ # Required. A set of keywords describing the skill's capabilities. + "A String", + ], + }, + ], + "supportedInterfaces": [ # Required. Ordered list of supported interfaces. The first entry is preferred. + { # Declares a combination of a target URL, transport and protocol version for interacting with the agent. This allows agents to expose the same functionality over multiple protocol binding mechanisms. + "protocolBinding": "A String", # Required. The protocol binding supported at this URL. This is an open form string, to be easily extended for other protocol bindings. The core ones officially supported are `JSONRPC`, `GRPC` and `HTTP+JSON`. + "protocolVersion": "A String", # Required. The version of the A2A protocol this interface exposes. Use the latest supported minor version per major version. Examples: "0.3", "1.0" + "tenant": "A String", # Tenant ID to be used in the request when calling the agent. + "url": "A String", # Required. The URL where this interface is available. Must be a valid absolute HTTPS URL in production. Example: "https://api.example.com/a2a/v1", "https://grpc.example.com/a2a" + }, + ], + "version": "A String", # Required. The version of the agent. + }, + "agentRegistry": "A String", # Optional. Reference to the agent in the Agent Registry. Format: `projects/{project}/locations/{location}/agents/{agent}` + "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication configuration for calling the remote agent. Optional if the registry reference already handles authentication. + "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth. + "apiKeySecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. + "keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name. + "requestLocation": "A String", # Required. Key location in the request. + }, + "bearerTokenConfig": { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth. + "token": "A String", # Required. The bearer token. Must be in the format `$context.variables.`. + }, + "oauthConfig": { # Configurations for authentication with OAuth. # Optional. Config for OAuth. + "clientId": "A String", # Required. The client ID from the OAuth provider. + "clientSecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. + "oauthGrantType": "A String", # Required. OAuth grant types. + "scopes": [ # Optional. The OAuth scopes to grant. + "A String", + ], + "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token. + }, + "serviceAccountAuthConfig": { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication. + "scopes": [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used. + "A String", + ], + "serviceAccount": "A String", # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. + }, + "serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent. + }, + }, + "contextId": "A String", # Optional. If not empty, interactions with the remote A2A agent will use this context ID. This context_id field can refer to a session variable like `$context.variables.order_agent_session_id`. + "inputVariableMapping": { # Optional. Mapping of input variable names of remote agent to GECX variable names. + "a_key": "A String", + }, + "outputVariableMapping": { # Optional. Mapping of output variable names of remote agent to GECX variable names. + "a_key": "A String", + }, + "streamingEnabled": True or False, # Optional. Whether streaming is enabled for the remote agent. + }, + }, "remoteDialogflowAgent": { # The agent which will transfer execution to a remote [Dialogflow CX](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent. The Dialogflow agent will process subsequent user queries until the session ends or flow ends, and the control is transferred back to the parent CES agent. # Optional. The remote [Dialogflow](https://cloud.google.com/dialogflow/cx/docs/concept/console-conversational-agents) agent to be used for the agent execution. If this field is set, all other agent level properties will be ignored. Note: If the Dialogflow agent is in a different project from the app, you should grant `roles/dialogflow.client` to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "agent": "A String", # Required. The [Dialogflow](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent resource name. Format: `projects/{project}/locations/{location}/agents/{agent}` "environmentId": "A String", # Optional. The environment ID of the Dialogflow agent to be used for the agent execution. If not specified, the draft environment will be used. @@ -256,6 +331,16 @@Method Details
"bargeInAwareness": True or False, # Optional. If enabled, the agent will adapt its next response based on the assumption that the user hasn't heard the full preceding agent message. This should not be used in scenarios where agent responses are displayed visually. "disableBargeIn": True or False, # Optional. Deprecated: `disable_barge_in` is deprecated in favor of `disable_barge_in_control` in ChannelProfile. Disables user barge-in while the agent is speaking. If true, user input during agent response playback will be ignored. }, + "customVoiceSamples": [ # Optional. Configures custom voice samples for voice cloning. + { # Configuration for a custom voice sample used for voice cloning. + "consentAudioGcsUri": "A String", # Optional. Consent audio for voice cloning. + "name": "A String", # Optional. The user-defined name for the custom voice sample. + "previewAudioContent": "A String", # Output only. Synthesized preview audio for custom voice, formatted as canonical WAV (LINEAR16, 24kHz, 16-bit, mono). + "previewText": "A String", # Optional. Text for synthesizing preview audio for custom voice. + "voiceInstruction": "A String", # Optional. Natural language instructions for voice style, tone, pacing, or pronunciation. + "voiceSampleGcsUri": "A String", # Optional. The Cloud Storage URI to the audio sample for voice cloning. The audio sample should be a mono-channel, 24kHz WAV file. + }, + ], "inactivityTimeout": "A String", # Optional. The duration of user inactivity (no speech or interaction) before the agent prompts the user for reengagement. If not set, the agent will not prompt the user for reengagement. "synthesizeSpeechConfigs": { # Optional. Configuration of how the agent response should be synthesized, mapping from the language code to SynthesizeSpeechConfig. If the configuration for the specified language code is not found, the configuration for the root language code will be used. For example, if the map contains "en-us" and "en", and the specified language code is "en-gb", then "en" configuration will be used. Note: Language code is case-insensitive. "a_key": { # Configuration for how the agent response should be synthesized. @@ -578,6 +663,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -1477,6 +1563,7 @@Method Details
}, ], }, + "updateTime": "A String", # Output only. Timestamp when the app version was last updated. } appVersionId: string, Optional. The ID to use for the app version, which will become the final component of the app version's resource name. If not provided, a unique ID will be automatically assigned for the app version. @@ -1565,6 +1652,78 @@Method Details
"temperature": 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative. }, "name": "A String", # Identifier. The unique identifier of the agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` + "remoteA2aAgent": { # The agent which will transfer execution to a remote [A2A](https://github.com/a2aproject/A2A) agent. # Optional. The remote [A2A](https://github.com/a2aproject/A2A) agent to be used for the agent execution. + "a2aConfig": { # Shared configuration for connecting to a remote [A2A](https://github.com/a2aproject/A2A) agent. # Required. The A2A connection configuration. + "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Optional. The full agent card defined inline. + "description": "A String", # Required. A description of the agent's domain of action/solution space. + "name": "A String", # Required. A human-readable name for the agent. + "skills": [ # Required. Skills represent a unit of ability an agent can perform. This may somewhat abstract but represents a more focused set of actions that the agent is highly likely to succeed at. + { # Represents a distinct capability or function that an agent can perform. + "description": "A String", # Required. A detailed description of the skill. + "examples": [ # Example prompts or scenarios that this skill can handle. + "A String", + ], + "id": "A String", # Required. A unique identifier for the agent's skill. + "inputModes": [ # The set of supported input media types for this skill, overriding the agent's defaults. + "A String", + ], + "name": "A String", # Required. A human-readable name for the skill. + "outputModes": [ # The set of supported output media types for this skill, overriding the agent's defaults. + "A String", + ], + "tags": [ # Required. A set of keywords describing the skill's capabilities. + "A String", + ], + }, + ], + "supportedInterfaces": [ # Required. Ordered list of supported interfaces. The first entry is preferred. + { # Declares a combination of a target URL, transport and protocol version for interacting with the agent. This allows agents to expose the same functionality over multiple protocol binding mechanisms. + "protocolBinding": "A String", # Required. The protocol binding supported at this URL. This is an open form string, to be easily extended for other protocol bindings. The core ones officially supported are `JSONRPC`, `GRPC` and `HTTP+JSON`. + "protocolVersion": "A String", # Required. The version of the A2A protocol this interface exposes. Use the latest supported minor version per major version. Examples: "0.3", "1.0" + "tenant": "A String", # Tenant ID to be used in the request when calling the agent. + "url": "A String", # Required. The URL where this interface is available. Must be a valid absolute HTTPS URL in production. Example: "https://api.example.com/a2a/v1", "https://grpc.example.com/a2a" + }, + ], + "version": "A String", # Required. The version of the agent. + }, + "agentRegistry": "A String", # Optional. Reference to the agent in the Agent Registry. Format: `projects/{project}/locations/{location}/agents/{agent}` + "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication configuration for calling the remote agent. Optional if the registry reference already handles authentication. + "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth. + "apiKeySecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. + "keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name. + "requestLocation": "A String", # Required. Key location in the request. + }, + "bearerTokenConfig": { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth. + "token": "A String", # Required. The bearer token. Must be in the format `$context.variables.`. + }, + "oauthConfig": { # Configurations for authentication with OAuth. # Optional. Config for OAuth. + "clientId": "A String", # Required. The client ID from the OAuth provider. + "clientSecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. + "oauthGrantType": "A String", # Required. OAuth grant types. + "scopes": [ # Optional. The OAuth scopes to grant. + "A String", + ], + "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token. + }, + "serviceAccountAuthConfig": { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication. + "scopes": [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used. + "A String", + ], + "serviceAccount": "A String", # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. + }, + "serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent. + }, + }, + "contextId": "A String", # Optional. If not empty, interactions with the remote A2A agent will use this context ID. This context_id field can refer to a session variable like `$context.variables.order_agent_session_id`. + "inputVariableMapping": { # Optional. Mapping of input variable names of remote agent to GECX variable names. + "a_key": "A String", + }, + "outputVariableMapping": { # Optional. Mapping of output variable names of remote agent to GECX variable names. + "a_key": "A String", + }, + "streamingEnabled": True or False, # Optional. Whether streaming is enabled for the remote agent. + }, + }, "remoteDialogflowAgent": { # The agent which will transfer execution to a remote [Dialogflow CX](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent. The Dialogflow agent will process subsequent user queries until the session ends or flow ends, and the control is transferred back to the parent CES agent. # Optional. The remote [Dialogflow](https://cloud.google.com/dialogflow/cx/docs/concept/console-conversational-agents) agent to be used for the agent execution. If this field is set, all other agent level properties will be ignored. Note: If the Dialogflow agent is in a different project from the app, you should grant `roles/dialogflow.client` to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "agent": "A String", # Required. The [Dialogflow](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent resource name. Format: `projects/{project}/locations/{location}/agents/{agent}` "environmentId": "A String", # Optional. The environment ID of the Dialogflow agent to be used for the agent execution. If not specified, the draft environment will be used. @@ -1626,6 +1785,16 @@Method Details
"bargeInAwareness": True or False, # Optional. If enabled, the agent will adapt its next response based on the assumption that the user hasn't heard the full preceding agent message. This should not be used in scenarios where agent responses are displayed visually. "disableBargeIn": True or False, # Optional. Deprecated: `disable_barge_in` is deprecated in favor of `disable_barge_in_control` in ChannelProfile. Disables user barge-in while the agent is speaking. If true, user input during agent response playback will be ignored. }, + "customVoiceSamples": [ # Optional. Configures custom voice samples for voice cloning. + { # Configuration for a custom voice sample used for voice cloning. + "consentAudioGcsUri": "A String", # Optional. Consent audio for voice cloning. + "name": "A String", # Optional. The user-defined name for the custom voice sample. + "previewAudioContent": "A String", # Output only. Synthesized preview audio for custom voice, formatted as canonical WAV (LINEAR16, 24kHz, 16-bit, mono). + "previewText": "A String", # Optional. Text for synthesizing preview audio for custom voice. + "voiceInstruction": "A String", # Optional. Natural language instructions for voice style, tone, pacing, or pronunciation. + "voiceSampleGcsUri": "A String", # Optional. The Cloud Storage URI to the audio sample for voice cloning. The audio sample should be a mono-channel, 24kHz WAV file. + }, + ], "inactivityTimeout": "A String", # Optional. The duration of user inactivity (no speech or interaction) before the agent prompts the user for reengagement. If not set, the agent will not prompt the user for reengagement. "synthesizeSpeechConfigs": { # Optional. Configuration of how the agent response should be synthesized, mapping from the language code to SynthesizeSpeechConfig. If the configuration for the specified language code is not found, the configuration for the root language code will be used. For example, if the map contains "en-us" and "en", and the specified language code is "en-gb", then "en" configuration will be used. Note: Language code is case-insensitive. "a_key": { # Configuration for how the agent response should be synthesized. @@ -1948,6 +2117,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -2847,6 +3017,7 @@Method Details
}, ], }, + "updateTime": "A String", # Output only. Timestamp when the app version was last updated. }
patch(name, body=None, updateMask=None, x__xgafv=None)
+ Updates the specified app version.
+
+Args:
+ name: string, Identifier. The unique identifier of the app version. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # In Customer Engagement Suite (CES), an app version is a snapshot of the app at a specific point in time. It is immutable and cannot be modified once created.
+ "createTime": "A String", # Output only. Timestamp when the app version was created.
+ "creator": "A String", # Output only. Email of the user who created the app version.
+ "description": "A String", # Optional. The description of the app version.
+ "displayName": "A String", # Optional. The display name of the app version.
+ "etag": "A String", # Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
+ "name": "A String", # Identifier. The unique identifier of the app version. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`
+ "snapshot": { # A snapshot of the app. # Output only. The snapshot of the app when the version is created.
+ "agents": [ # Optional. List of agents in the app.
+ { # An agent acts as the fundamental building block that provides instructions to the Large Language Model (LLM) for executing specific tasks.
+ "afterAgentCallbacks": [ # Optional. The callbacks to execute after the agent is called. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.
+ { # A callback defines the custom logic to be executed at various stages of agent interaction.
+ "description": "A String", # Optional. Human-readable description of the callback.
+ "disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
+ "pythonCode": "A String", # Required. The python code to execute for the callback.
+ },
+ ],
+ "afterModelCallbacks": [ # Optional. The callbacks to execute after the model is called. If there are multiple calls to the model, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.
+ { # A callback defines the custom logic to be executed at various stages of agent interaction.
+ "description": "A String", # Optional. Human-readable description of the callback.
+ "disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
+ "pythonCode": "A String", # Required. The python code to execute for the callback.
+ },
+ ],
+ "afterToolCallbacks": [ # Optional. The callbacks to execute after the tool is invoked. If there are multiple tool invocations, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.
+ { # A callback defines the custom logic to be executed at various stages of agent interaction.
+ "description": "A String", # Optional. Human-readable description of the callback.
+ "disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
+ "pythonCode": "A String", # Required. The python code to execute for the callback.
+ },
+ ],
+ "beforeAgentCallbacks": [ # Optional. The callbacks to execute before the agent is called. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.
+ { # A callback defines the custom logic to be executed at various stages of agent interaction.
+ "description": "A String", # Optional. Human-readable description of the callback.
+ "disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
+ "pythonCode": "A String", # Required. The python code to execute for the callback.
+ },
+ ],
+ "beforeModelCallbacks": [ # Optional. The callbacks to execute before the model is called. If there are multiple calls to the model, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.
+ { # A callback defines the custom logic to be executed at various stages of agent interaction.
+ "description": "A String", # Optional. Human-readable description of the callback.
+ "disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
+ "pythonCode": "A String", # Required. The python code to execute for the callback.
+ },
+ ],
+ "beforeToolCallbacks": [ # Optional. The callbacks to execute before the tool is invoked. If there are multiple tool invocations, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.
+ { # A callback defines the custom logic to be executed at various stages of agent interaction.
+ "description": "A String", # Optional. Human-readable description of the callback.
+ "disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
+ "pythonCode": "A String", # Required. The python code to execute for the callback.
+ },
+ ],
+ "childAgents": [ # Optional. List of child agents in the agent tree. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
+ "A String",
+ ],
+ "createTime": "A String", # Output only. Timestamp when the agent was created.
+ "description": "A String", # Optional. Human-readable description of the agent.
+ "displayName": "A String", # Required. Display name of the agent.
+ "etag": "A String", # Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
+ "generatedSummary": "A String", # Output only. If the agent is generated by the LLM assistant, this field contains a descriptive summary of the generation.
+ "guardrails": [ # Optional. List of guardrails for the agent. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`
+ "A String",
+ ],
+ "instruction": "A String", # Optional. Instructions for the LLM model to guide the agent's behavior.
+ "llmAgent": { # Default agent type. The agent uses instructions and callbacks specified in the agent to perform the task using a large language model. # Optional. The default agent type.
+ },
+ "modelSettings": { # Model settings contains various configurations for the LLM model. # Optional. Configurations for the LLM model.
+ "model": "A String", # Optional. The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
+ "temperature": 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
+ },
+ "name": "A String", # Identifier. The unique identifier of the agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
+ "remoteA2aAgent": { # The agent which will transfer execution to a remote [A2A](https://github.com/a2aproject/A2A) agent. # Optional. The remote [A2A](https://github.com/a2aproject/A2A) agent to be used for the agent execution.
+ "a2aConfig": { # Shared configuration for connecting to a remote [A2A](https://github.com/a2aproject/A2A) agent. # Required. The A2A connection configuration.
+ "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Optional. The full agent card defined inline.
+ "description": "A String", # Required. A description of the agent's domain of action/solution space.
+ "name": "A String", # Required. A human-readable name for the agent.
+ "skills": [ # Required. Skills represent a unit of ability an agent can perform. This may somewhat abstract but represents a more focused set of actions that the agent is highly likely to succeed at.
+ { # Represents a distinct capability or function that an agent can perform.
+ "description": "A String", # Required. A detailed description of the skill.
+ "examples": [ # Example prompts or scenarios that this skill can handle.
+ "A String",
+ ],
+ "id": "A String", # Required. A unique identifier for the agent's skill.
+ "inputModes": [ # The set of supported input media types for this skill, overriding the agent's defaults.
+ "A String",
+ ],
+ "name": "A String", # Required. A human-readable name for the skill.
+ "outputModes": [ # The set of supported output media types for this skill, overriding the agent's defaults.
+ "A String",
+ ],
+ "tags": [ # Required. A set of keywords describing the skill's capabilities.
+ "A String",
+ ],
+ },
+ ],
+ "supportedInterfaces": [ # Required. Ordered list of supported interfaces. The first entry is preferred.
+ { # Declares a combination of a target URL, transport and protocol version for interacting with the agent. This allows agents to expose the same functionality over multiple protocol binding mechanisms.
+ "protocolBinding": "A String", # Required. The protocol binding supported at this URL. This is an open form string, to be easily extended for other protocol bindings. The core ones officially supported are `JSONRPC`, `GRPC` and `HTTP+JSON`.
+ "protocolVersion": "A String", # Required. The version of the A2A protocol this interface exposes. Use the latest supported minor version per major version. Examples: "0.3", "1.0"
+ "tenant": "A String", # Tenant ID to be used in the request when calling the agent.
+ "url": "A String", # Required. The URL where this interface is available. Must be a valid absolute HTTPS URL in production. Example: "https://api.example.com/a2a/v1", "https://grpc.example.com/a2a"
+ },
+ ],
+ "version": "A String", # Required. The version of the agent.
+ },
+ "agentRegistry": "A String", # Optional. Reference to the agent in the Agent Registry. Format: `projects/{project}/locations/{location}/agents/{agent}`
+ "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication configuration for calling the remote agent. Optional if the registry reference already handles authentication.
+ "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth.
+ "apiKeySecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
+ "requestLocation": "A String", # Required. Key location in the request.
+ },
+ "bearerTokenConfig": { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth.
+ "token": "A String", # Required. The bearer token. Must be in the format `$context.variables.`.
+ },
+ "oauthConfig": { # Configurations for authentication with OAuth. # Optional. Config for OAuth.
+ "clientId": "A String", # Required. The client ID from the OAuth provider.
+ "clientSecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "oauthGrantType": "A String", # Required. OAuth grant types.
+ "scopes": [ # Optional. The OAuth scopes to grant.
+ "A String",
+ ],
+ "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
+ },
+ "serviceAccountAuthConfig": { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication.
+ "scopes": [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.
+ "A String",
+ ],
+ "serviceAccount": "A String", # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ },
+ "serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent.
+ },
+ },
+ "contextId": "A String", # Optional. If not empty, interactions with the remote A2A agent will use this context ID. This context_id field can refer to a session variable like `$context.variables.order_agent_session_id`.
+ "inputVariableMapping": { # Optional. Mapping of input variable names of remote agent to GECX variable names.
+ "a_key": "A String",
+ },
+ "outputVariableMapping": { # Optional. Mapping of output variable names of remote agent to GECX variable names.
+ "a_key": "A String",
+ },
+ "streamingEnabled": True or False, # Optional. Whether streaming is enabled for the remote agent.
+ },
+ },
+ "remoteDialogflowAgent": { # The agent which will transfer execution to a remote [Dialogflow CX](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent. The Dialogflow agent will process subsequent user queries until the session ends or flow ends, and the control is transferred back to the parent CES agent. # Optional. The remote [Dialogflow](https://cloud.google.com/dialogflow/cx/docs/concept/console-conversational-agents) agent to be used for the agent execution. If this field is set, all other agent level properties will be ignored. Note: If the Dialogflow agent is in a different project from the app, you should grant `roles/dialogflow.client` to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "agent": "A String", # Required. The [Dialogflow](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent resource name. Format: `projects/{project}/locations/{location}/agents/{agent}`
+ "environmentId": "A String", # Optional. The environment ID of the Dialogflow agent to be used for the agent execution. If not specified, the draft environment will be used.
+ "flowId": "A String", # Optional. The flow ID of the flow in the Dialogflow agent.
+ "inputVariableMapping": { # Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input.
+ "a_key": "A String",
+ },
+ "languageCodeVariable": "A String", # Optional. The name of the variable that contains the language code to be used for the Dialogflow session. If unspecified, the default language code of the Dialogflow agent will be used.
+ "outputVariableMapping": { # Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends.
+ "a_key": "A String",
+ },
+ "respectResponseInterruptionSettings": True or False, # Optional. Indicates whether to respect the message-level interruption settings configured in the Dialogflow agent. * If false: all response messages from the Dialogflow agent follow the app-level barge-in settings. * If true: only response messages with [`allow_playback_interruption`](https://docs.cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#text) set to true will be interruptable, all other messages follow the app-level barge-in settings.
+ },
+ "tools": [ # Optional. List of available tools for the agent. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
+ "A String",
+ ],
+ "toolsets": [ # Optional. List of toolsets for the agent.
+ { # A toolset with a selection of its tools.
+ "toolIds": [ # Optional. The tools IDs to filter the toolset.
+ "A String",
+ ],
+ "toolset": "A String", # Required. The resource name of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
+ },
+ ],
+ "transferRules": [ # Optional. Agent transfer rules. If multiple rules match, the first one in the list will be used.
+ { # Rule for transferring to a specific agent.
+ "childAgent": "A String", # Required. The resource name of the child agent the rule applies to. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
+ "deterministicTransfer": { # Deterministic transfer rule. When the condition evaluates to true, the transfer occurs. # Optional. A rule that immediately transfers to the target agent when the condition is met.
+ "expressionCondition": { # Expression condition based on session state. # Optional. A rule that evaluates a session state condition. If the condition evaluates to true, the transfer occurs.
+ "expression": "A String", # Required. The string representation of cloud.api.Expression condition.
+ },
+ "pythonCodeCondition": { # Python code block to evaluate the condition. # Optional. A rule that uses Python code block to evaluate the conditions. If the condition evaluates to true, the transfer occurs.
+ "pythonCode": "A String", # Required. The python code to execute.
+ },
+ },
+ "direction": "A String", # Required. The direction of the transfer.
+ "disablePlannerTransfer": { # A rule that prevents the planner from transferring to the target agent. # Optional. Rule that prevents the planner from transferring to the target agent.
+ "expressionCondition": { # Expression condition based on session state. # Required. If the condition evaluates to true, planner will not be allowed to transfer to the target agent.
+ "expression": "A String", # Required. The string representation of cloud.api.Expression condition.
+ },
+ },
+ },
+ ],
+ "updateTime": "A String", # Output only. Timestamp when the agent was last updated.
+ "validationErrors": [ # Output only. Misconfigurations or errors in the agent that may affect agent quality.
+ "A String",
+ ],
+ },
+ ],
+ "app": { # An app serves as a top-level container for a group of agents, including the root agent and its sub-agents, along with their associated configurations. These agents work together to achieve specific goals within the app's context. # Optional. The basic settings for the app.
+ "audioProcessingConfig": { # Configuration for how the input and output audio should be processed and delivered. # Optional. Audio processing configuration of the app.
+ "ambientSoundConfig": { # Configuration for the ambient sound to be played with the synthesized agent response, to enhance the naturalness of the conversation. # Optional. Configuration for the ambient sound to be played with the synthesized agent response, to enhance the naturalness of the conversation.
+ "gcsUri": "A String", # Optional. Ambient noise as a mono-channel, 16kHz WAV file stored in [Cloud Storage](https://cloud.google.com/storage). Note: Please make sure the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com` has `storage.objects.get` permission to the Cloud Storage object.
+ "prebuiltAmbientNoise": "A String", # Optional. Deprecated: `prebuilt_ambient_noise` is deprecated in favor of `prebuilt_ambient_sound`.
+ "prebuiltAmbientSound": "A String", # Optional. Name of the prebuilt ambient sound. Valid values are: - "coffee_shop" - "keyboard" - "keypad" - "hum" - "office_1" - "office_2" - "office_3" - "room_1" - "room_2" - "room_3" - "room_4" - "room_5" - "air_conditioner"
+ "volumeGainDb": 3.14, # Optional. Volume gain (in dB) of the normal native volume supported by ambient noise, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.
+ },
+ "bargeInConfig": { # Configuration for how the user barge-in activities should be handled. # Optional. Configures the agent behavior for the user barge-in activities.
+ "bargeInAwareness": True or False, # Optional. If enabled, the agent will adapt its next response based on the assumption that the user hasn't heard the full preceding agent message. This should not be used in scenarios where agent responses are displayed visually.
+ "disableBargeIn": True or False, # Optional. Deprecated: `disable_barge_in` is deprecated in favor of `disable_barge_in_control` in ChannelProfile. Disables user barge-in while the agent is speaking. If true, user input during agent response playback will be ignored.
+ },
+ "customVoiceSamples": [ # Optional. Configures custom voice samples for voice cloning.
+ { # Configuration for a custom voice sample used for voice cloning.
+ "consentAudioGcsUri": "A String", # Optional. Consent audio for voice cloning.
+ "name": "A String", # Optional. The user-defined name for the custom voice sample.
+ "previewAudioContent": "A String", # Output only. Synthesized preview audio for custom voice, formatted as canonical WAV (LINEAR16, 24kHz, 16-bit, mono).
+ "previewText": "A String", # Optional. Text for synthesizing preview audio for custom voice.
+ "voiceInstruction": "A String", # Optional. Natural language instructions for voice style, tone, pacing, or pronunciation.
+ "voiceSampleGcsUri": "A String", # Optional. The Cloud Storage URI to the audio sample for voice cloning. The audio sample should be a mono-channel, 24kHz WAV file.
+ },
+ ],
+ "inactivityTimeout": "A String", # Optional. The duration of user inactivity (no speech or interaction) before the agent prompts the user for reengagement. If not set, the agent will not prompt the user for reengagement.
+ "synthesizeSpeechConfigs": { # Optional. Configuration of how the agent response should be synthesized, mapping from the language code to SynthesizeSpeechConfig. If the configuration for the specified language code is not found, the configuration for the root language code will be used. For example, if the map contains "en-us" and "en", and the specified language code is "en-gb", then "en" configuration will be used. Note: Language code is case-insensitive.
+ "a_key": { # Configuration for how the agent response should be synthesized.
+ "consentAudioGcsUri": "A String", # Optional. Deprecated: Use `custom_voice_samples` in AudioProcessingConfig instead. The Cloud Storage URI to the consent audio for voice cloning.
+ "instruction": "A String", # Optional. The instruction used to synthesize speech when using a generative model.
+ "model": "A String", # Optional. The model used to synthesize audio. Currently supported values: - "gemini-3.1-flash-tts-preview" If empty, Chirp3-HD is used.
+ "speakingRate": 3.14, # Optional. The speaking rate/speed in the range [0.25, 2.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. Values outside of the range [0.25, 2.0] will return an error.
+ "voice": "A String", # Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices) from Cloud Text-to-Speech.
+ "voiceSampleGcsUri": "A String", # Optional. Deprecated: Use `custom_voice_samples` in AudioProcessingConfig instead. The Cloud Storage URI to the audio sample for voice cloning. The audio sample should be a mono-channel, 24kHz WAV file. Note: Please make sure the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com` has `storage.objects.get` permission to the Cloud Storage object.
+ },
+ },
+ },
+ "clientCertificateSettings": { # Settings for custom client certificates. # Optional. The default client certificate settings for the app.
+ "passphrase": "A String", # Optional. The name of the SecretManager secret version resource storing the passphrase to decrypt the private key. Should be left unset if the private key is not encrypted. Format: `projects/{project}/secrets/{secret}/versions/{version}`
+ "privateKey": "A String", # Required. The name of the SecretManager secret version resource storing the private key encoded in PEM format. Format: `projects/{project}/secrets/{secret}/versions/{version}`
+ "tlsCertificate": "A String", # Required. The TLS certificate encoded in PEM format. This string must include the begin header and end footer lines.
+ },
+ "createTime": "A String", # Output only. Timestamp when the app was created.
+ "dashboardSettings": { # Settings for dashboards associated with the app, that show up in the Monitoring view. # Optional. App-specific dashboard settings for linking and configuring Contact Center Insights dashboards.
+ "defaultDashboard": "A String", # Optional. The resource name of the default Contact Center Insights dashboard associated with the app. This is the dashboard that will be displayed when users navigate to the Monitoring view for the app. Format: `projects/{project}/locations/{location}/dashboards/{dashboard}`
+ },
+ "dataStoreSettings": { # Data store related settings for the app. # Optional. The data store settings for the app.
+ "engines": [ # Output only. The engines for the app.
+ { # An engine to which the data stores are connected. See Vertex AI Search: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction.
+ "name": "A String", # Output only. The resource name of the engine. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
+ "type": "A String", # Output only. The type of the engine.
+ },
+ ],
+ },
+ "defaultChannelProfile": { # A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony. # Optional. The default channel profile used by the app.
+ "channelType": "A String", # Optional. The type of the channel profile.
+ "disableBargeInControl": True or False, # Optional. Whether to disable user barge-in control in the conversation. - **true**: User interruptions are disabled while the agent is speaking. - **false**: The agent retains automatic control over when the user can interrupt.
+ "disableDtmf": True or False, # Optional. Whether to disable DTMF (dual-tone multi-frequency).
+ "instagramConfig": { # Configuration specific to Instagram deployments. # Optional. Configuration specific to Instagram deployments.
+ "description": "A String", # Output only. The description of the Meta business page or profile.
+ "displayName": "A String", # Output only. The fetched Meta business page name.
+ "instagramAccountId": "A String", # Required. The Instagram Account ID.
+ "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL.
+ },
+ "noiseSuppressionLevel": "A String", # Optional. The noise suppression level of the channel profile. Available values are "low", "moderate", "high", "very_high".
+ "personaProperty": { # Represents the persona property of a channel. # Optional. The persona property of the channel profile.
+ "persona": "A String", # Optional. The persona of the channel.
+ },
+ "profileId": "A String", # Optional. The unique identifier of the channel profile.
+ "webWidgetConfig": { # Message for configuration for the web widget. # Optional. The configuration for the web widget.
+ "modality": "A String", # Optional. The modality of the web widget.
+ "securitySettings": { # Security settings for the web widget. # Optional. The security settings of the web widget.
+ "allowedOrigins": [ # Optional. The origins that are allowed to host the web widget. An origin is defined by RFC 6454. If empty, all origins are allowed. A maximum of 100 origins is allowed. Example: "https://example.com"
+ "A String",
+ ],
+ "enableOriginCheck": True or False, # Optional. Indicates whether origin check for the web widget is enabled. If `true`, the web widget will check the origin of the website that loads the web widget and only allow it to be loaded in the same origin or any of the allowed origins.
+ "enablePublicAccess": True or False, # Optional. Indicates whether public access to the web widget is enabled. If `true`, the web widget will be publicly accessible. If `false`, the web widget must be integrated with your own authentication and authorization system to return valid credentials for accessing the CES agent.
+ "enableRecaptcha": True or False, # Optional. Indicates whether reCAPTCHA verification for the web widget is enabled.
+ },
+ "theme": "A String", # Optional. The theme of the web widget.
+ "webWidgetTitle": "A String", # Optional. The title of the web widget.
+ },
+ "whatsappConfig": { # Configuration specific to WhatsApp deployments. # Optional. Configuration specific to WhatsApp deployments.
+ "description": "A String", # Output only. The description of the Meta business page or profile.
+ "displayName": "A String", # Output only. The fetched Meta business page name.
+ "phoneNumber": "A String", # Optional. The phone number in E.164 format.
+ "phoneNumberId": "A String", # Required. The Meta phone number ID.
+ "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL.
+ "wabaId": "A String", # Required. The WhatsApp Business Account ID.
+ },
+ },
+ "deploymentCount": 42, # Output only. Number of deployments in the app.
+ "description": "A String", # Optional. Human-readable description of the app.
+ "displayName": "A String", # Required. Display name of the app.
+ "errorHandlingSettings": { # Settings to describe how errors should be handled in the app. # Optional. Error handling settings of the app.
+ "endSessionConfig": { # Configuration for ending the session in case of system errors (e.g. LLM errors). # Optional. Configuration for ending the session in case of system errors (e.g. LLM errors).
+ "escalateSession": True or False, # Optional. Whether to escalate the session in EndSession. If session is escalated, metadata in EndSession will contain `session_escalated = true`. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/deploy/google-telephony-platform#transfer_a_call_to_a_human_agent for details.
+ },
+ "errorHandlingStrategy": "A String", # Optional. The strategy to use for error handling.
+ "fallbackResponseConfig": { # Configuration for handling fallback responses. # Optional. Configuration for handling fallback responses.
+ "customFallbackMessages": { # Optional. The fallback messages in case of system errors (e.g. LLM errors), mapped by [supported language code](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/reference/language).
+ "a_key": "A String",
+ },
+ "maxFallbackAttempts": 42, # Optional. The maximum number of fallback attempts to make before the agent emitting EndSession Signal.
+ },
+ },
+ "etag": "A String", # Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
+ "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Optional. The evaluation thresholds for the app.
+ "goldenEvaluationMetricsThresholds": { # Settings for golden evaluations. # Optional. The golden evaluation metrics thresholds.
+ "expectationLevelMetricsThresholds": { # Expectation level metrics thresholds. # Optional. The expectation level metrics thresholds.
+ "toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0.
+ },
+ "toolMatchingSettings": { # Settings for matching tool calls. # Optional. The tool matching settings. An extra tool call is a tool call that is present in the execution but does not match any tool call in the golden expectation.
+ "extraToolCallBehavior": "A String", # Optional. Behavior for extra tool calls. Defaults to FAIL.
+ },
+ "turnLevelMetricsThresholds": { # Turn level metrics thresholds. # Optional. The turn level metrics thresholds.
+ "overallToolInvocationCorrectnessThreshold": 3.14, # Optional. The success threshold for overall tool invocation correctness. Must be a float between 0 and 1. Default is 1.0.
+ "semanticSimilarityChannel": "A String", # Optional. The semantic similarity channel to use for evaluation.
+ "semanticSimilaritySuccessThreshold": 42, # Optional. The success threshold for semantic similarity. Must be an integer between 0 and 4. Default is >= 3.
+ },
+ },
+ "goldenHallucinationMetricBehavior": "A String", # Optional. The hallucination metric behavior for golden evaluations.
+ "hallucinationMetricBehavior": "A String", # Optional. Deprecated: Use `golden_hallucination_metric_behavior` instead. The hallucination metric behavior is currently used for golden evaluations.
+ "scenarioHallucinationMetricBehavior": "A String", # Optional. The hallucination metric behavior for scenario evaluations.
+ },
+ "evaluationPersonas": [ # Optional. The evaluation personas for the app. This field is used to define the personas that can be used for evaluation. Maximum of 30 personas can be defined.
+ { # A persona represents an end user in an evaluation.
+ "description": "A String", # Optional. The description of the persona.
+ "displayName": "A String", # Required. The display name of the persona. Unique within an app.
+ "name": "A String", # Required. The unique identifier of the persona. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationPersonas/{evaluationPersona}`
+ "personality": "A String", # Required. An instruction for the agent on how to behave in the evaluation.
+ "speechConfig": { # Configuration for Text-to-Speech generation. # Optional. Configuration for how the persona sounds (TTS settings).
+ "environment": "A String", # Optional. The simulated audio environment.
+ "speakingRate": 3.14, # Optional. The speaking rate. 1.0 is normal. Lower is slower (e.g., 0.8), higher is faster (e.g., 1.5). Useful for testing how the agent handles fast talkers.
+ "voiceId": "A String", # Optional. The specific voice identifier/accent to use. Example: "en-US-Wavenet-D" or "en-GB-Standard-A"
+ },
+ },
+ ],
+ "evaluationSettings": { # Settings for evaluation. # Optional. The evaluation settings for the app.
+ "evaluationRunCachingSettings": { # Settings for evaluation run caching. # Optional. The caching settings to use for the evaluation run.
+ "runCachingMode": "A String", # Optional. The caching mode to use for the evaluation run. If not set, default to FORCE_RUN.
+ },
+ "goldenEvaluationToolCallBehaviour": "A String", # Optional. Configures the default tool call behaviour for golden evaluations.
+ "goldenRunMethod": "A String", # Optional. The default method used to run golden evaluations. This will be used if no golden_run_method is specified in the RunEvaluationRequest.
+ "metricsConfig": { # Configures the metrics for an evaluation. # Optional. Configures the default metrics for evaluations.
+ "goldenMetricsConfig": { # Configuration for the golden metrics for the evaluation. # Optional. Configuration for the golden metrics for the evaluation.
+ "semanticSimilarityMetricsConfig": { # Configuration for similarity metrics for the evaluation. To disable the metric, set the message but do not set the `enable_semantic_similarity_metrics` field to true (or explicitly set it to false). To unset the configuration and fallback to the default behavior, omit the message entirely. # Optional. Global configuration for semantic similarity metrics.
+ "enableSemanticSimilarityMetrics": True or False, # Optional. Whether to calculate semantic similarity metrics for the evaluation.
+ },
+ "stepToolCorrectnessMetricsConfig": { # Configuration for correctness metrics for the evaluation. To disable the metric, set the message but do not set the `enable_tool_correctness_metrics` field to true (or explicitly set it to false). To unset the configuration and fallback to the default behavior, omit the message entirely. # Optional. Configuration for step level tool correctness metrics.
+ "enableToolCorrectnessMetrics": True or False, # Optional. Whether to calculate tool correctness metrics for the evaluation.
+ },
+ "toolCorrectnessMetricsConfig": { # Configuration for correctness metrics for the evaluation. To disable the metric, set the message but do not set the `enable_tool_correctness_metrics` field to true (or explicitly set it to false). To unset the configuration and fallback to the default behavior, omit the message entirely. # Optional. Configuration for turn level tool correctness metrics.
+ "enableToolCorrectnessMetrics": True or False, # Optional. Whether to calculate tool correctness metrics for the evaluation.
+ },
+ },
+ "scenarioMetricsConfig": { # Configuration for the scenario metrics for the evaluation. # Optional. Configuration for the scenario metrics for the evaluation.
+ "expectationsMetMetricsConfig": { # Configuration for the expectation level metrics for the evaluation. To disable the metric, set the message but do not set the `enable_expectations_met_metrics` field to true (or explicitly set it to false). To unset the configuration and fallback to the default behavior, omit the message entirely. # Optional. Configuration for expectation level metrics.
+ "enableExpectationsMetMetrics": True or False, # Optional. Whether to calculate the expectation level metrics for the evaluation.
+ },
+ "userGoalMetMetricsConfig": { # Configuration for the user goal met metrics for the evaluation. To disable the metric, set the message but do not set the `enable_user_goal_met_metrics` field to true (or explicitly set it to false). To unset the configuration and fallback to the default behavior, omit the message entirely. # Optional. Configuration for user goal met metrics.
+ "enableUserGoalMetMetrics": True or False, # Optional. Whether to calculate the user goal met metrics for the evaluation.
+ },
+ },
+ },
+ "scenarioConversationInitiator": "A String", # Optional. Who starts the conversation in a scenario evaluation.
+ "scenarioEvaluationToolCallBehaviour": "A String", # Optional. Configures the default tool call behaviour for scenario evaluations.
+ "scenarioExecutionMode": "A String", # Optional. The execution mode for scenario evaluations. If not provided, will default to QUALITY_OPTIMIZED.
+ },
+ "globalInstruction": "A String", # Optional. Instructions for all the agents in the app. You can use this instruction to set up a stable identity or personality across all the agents.
+ "guardrails": [ # Optional. List of guardrails for the app. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`
+ "A String",
+ ],
+ "languageSettings": { # Language settings of the app. # Optional. Language settings of the app.
+ "defaultLanguageCode": "A String", # Optional. The default language code of the app.
+ "enableMultilingualSupport": True or False, # Optional. Enables multilingual support. If true, agents in the app will use pre-built instructions to improve handling of multilingual input.
+ "fallbackAction": "A String", # Optional. Deprecated: This feature is no longer supported. Use `enable_multilingual_support` instead to improve handling of multilingual input. The action to perform when an agent receives input in an unsupported language. This can be a predefined action or a custom tool call. Valid values are: - A tool's full resource name, which triggers a specific tool execution. - A predefined system action, such as "escalate" or "exit", which triggers an EndSession signal with corresponding metadata to terminate the conversation.
+ "supportedLanguageCodes": [ # Optional. List of languages codes supported by the app, in addition to the `default_language_code`.
+ "A String",
+ ],
+ },
+ "locked": True or False, # Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected.
+ "loggingSettings": { # Settings to describe the logging behaviors for the app. # Optional. Logging settings of the app.
+ "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. The audio is subject to redaction as configured in RedactionConfig.
+ "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used.
+ },
+ "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The conversation data is subject to redaction as configured in RedactionConfig.
+ "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to.
+ "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled.
+ "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ },
+ "cloudLoggingSettings": { # Settings to describe the Cloud Logging behaviors for the app. # Optional. Settings to describe the Cloud Logging behaviors for the app.
+ "enableCloudLogging": True or False, # Optional. Whether to enable Cloud Logging for the sessions.
+ },
+ "conversationLoggingSettings": { # Settings to describe the conversation logging behaviors for the app. # Optional. Settings to describe the conversation logging behaviors for the app.
+ "disableConversationLogging": True or False, # Optional. Whether to disable conversation logging for the sessions.
+ "retentionWindow": "A String", # Optional. Controls the retention window for the conversation. If not set, the conversation will be retained for 365 days.
+ },
+ "evaluationAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded for the evaluation. By default, audio recording is not enabled for evaluation sessions.
+ "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used.
+ },
+ "metricAnalysisSettings": { # Settings to describe the conversation data collection behaviors for LLM analysis metrics pipeline. # Optional. Settings to describe the conversation data collection behaviors for the LLM analysis pipeline for the app.
+ "llmMetricsOptedOut": True or False, # Optional. Whether to collect conversation data for llm analysis metrics. If true, conversation data will not be collected for llm analysis metrics; otherwise, conversation data will be collected.
+ },
+ "redactionConfig": { # Configuration to instruct how sensitive data should be handled. # Optional. Configuration for how sensitive data should be redacted.
+ "deidentifyTemplate": "A String", # Optional. [DLP](https://cloud.google.com/dlp/docs) deidentify template name to instruct on how to de-identify content. Format: `projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template}`
+ "enableRedaction": True or False, # Optional. If true, redaction will be applied in various logging scenarios, including conversation history, Cloud Logging and audio recording.
+ "inspectTemplate": "A String", # Optional. [DLP](https://cloud.google.com/dlp/docs) inspect template name to configure detection of sensitive data types. Format: `projects/{project}/locations/{location}/inspectTemplates/{inspect_template}`
+ },
+ "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures an additional recording of unredacted audio. This can be used to maintain a raw audio copy when audio redaction is enabled, typically for auditing or monitoring purposes.
+ "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used.
+ },
+ "unredactedBigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The unredacted conversation data will be exported to BigQuery tables if it is enabled.
+ "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to.
+ "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled.
+ "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ },
+ },
+ "metadata": { # Optional. Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages.
+ "a_key": "A String",
+ },
+ "modelSettings": { # Model settings contains various configurations for the LLM model. # Optional. The default LLM model settings for the app. Individual resources (e.g. agents, guardrails) can override these configurations as needed.
+ "model": "A String", # Optional. The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
+ "temperature": 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
+ },
+ "name": "A String", # Identifier. The unique identifier of the app. Format: `projects/{project}/locations/{location}/apps/{app}`
+ "pinned": True or False, # Optional. Whether the app is pinned in the app list.
+ "predefinedVariableDeclarations": [ # Output only. The declarations of predefined variables for the app.
+ { # Defines the structure and metadata for a variable.
+ "description": "A String", # Required. The description of the variable.
+ "name": "A String", # Required. The name of the variable. The name must start with a letter or underscore and contain only letters, numbers, or underscores.
+ "schema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Required. The schema of the variable.
+ "additionalProperties": # Object with schema name: Schema # 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: Schema
+ ],
+ "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: Schema
+ },
+ "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",
+ ],
+ "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
+ "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+ "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
+ "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+ "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
+ "nullable": True or False, # Optional. Indicates if the value may be null.
+ "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY.
+ # Object with schema name: Schema
+ ],
+ "properties": { # Optional. Properties of Type.OBJECT.
+ "a_key": # Object with schema name: Schema
+ },
+ "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", # Required. The type of the data.
+ "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
+ },
+ },
+ ],
+ "rootAgent": "A String", # Optional. The root agent is the entry point of the app. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
+ "timeZoneSettings": { # TimeZone settings of the app. # Optional. TimeZone settings of the app.
+ "timeZone": "A String", # Optional. The time zone of the app from the [time zone database](https://www.iana.org/time-zones), e.g., America/Los_Angeles, Europe/Paris.
+ },
+ "toolExecutionMode": "A String", # Optional. The tool execution mode for the app. If not provided, will default to PARALLEL.
+ "updateTime": "A String", # Output only. Timestamp when the app was last updated.
+ "validationErrors": [ # Output only. Misconfigurations or warnings in the app.
+ "A String",
+ ],
+ "variableDeclarations": [ # Optional. The declarations of the variables.
+ { # Defines the structure and metadata for a variable.
+ "description": "A String", # Required. The description of the variable.
+ "name": "A String", # Required. The name of the variable. The name must start with a letter or underscore and contain only letters, numbers, or underscores.
+ "schema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Required. The schema of the variable.
+ "additionalProperties": # Object with schema name: Schema # 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: Schema
+ ],
+ "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: Schema
+ },
+ "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",
+ ],
+ "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
+ "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+ "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
+ "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+ "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
+ "nullable": True or False, # Optional. Indicates if the value may be null.
+ "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY.
+ # Object with schema name: Schema
+ ],
+ "properties": { # Optional. Properties of Type.OBJECT.
+ "a_key": # Object with schema name: Schema
+ },
+ "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", # Required. The type of the data.
+ "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
+ },
+ },
+ ],
+ "vpcScSettings": { # VPC-SC settings for the app. # Optional. VPC-SC settings for the app.
+ "allowedOrigins": [ # Optional. The allowed HTTP(s) origins that OpenAPI tools in the App are able to directly call when VPC Service Controls are enabled. These strings must match the origin exactly, including the port if specified. For example, "https://example.com" or "https://example.com:443". This list does not yet apply to Python tools that may make direct HTTP calls.
+ "A String",
+ ],
+ },
+ },
+ "examples": [ # Optional. List of examples in the app.
+ { # An example represents a sample conversation between the user and the agent(s).
+ "createTime": "A String", # Output only. Timestamp when the example was created.
+ "description": "A String", # Optional. Human-readable description of the example.
+ "displayName": "A String", # Required. Display name of the example.
+ "entryAgent": "A String", # Optional. The agent that initially handles the conversation. If not specified, the example represents a conversation that is handled by the root agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
+ "etag": "A String", # Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
+ "invalid": True or False, # Output only. The example may become invalid if referencing resources are deleted. Invalid examples will not be used as few-shot examples.
+ "messages": [ # Optional. The collection of messages that make up the conversation.
+ { # A message within a conversation.
+ "chunks": [ # Optional. Content of the message as a series of chunks.
+ { # A chunk of content within a message.
+ "agentTransfer": { # Represents an event indicating the transfer of a conversation to a different agent. # Optional. Agent transfer event.
+ "displayName": "A String", # Output only. Display name of the agent.
+ "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
+ },
+ "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data.
+ "data": "A String", # Required. Raw bytes of the blob.
+ "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+ },
+ "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names.
+ "a_key": "", # Properties of the object.
+ },
+ "image": { # Represents an image input or output in the conversation. # Optional. Image data.
+ "altText": "A String", # Optional. The alternative text for the image.
+ "data": "A String", # Required. Raw bytes of the image.
+ "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp
+ },
+ "payload": { # Optional. Custom payload data.
+ "a_key": "", # Properties of the object.
+ },
+ "text": "A String", # Optional. Text data.
+ "toolCall": { # Request for the client or the agent to execute the specified tool. # Optional. Tool execution request.
+ "agentName": "A String", # Output only. Human-readable name of the agent that issued this call, e.g. "Contract Architect". Empty when the root agent issued it.
+ "args": { # Optional. The input parameters and values for the tool in JSON object format.
+ "a_key": "", # Properties of the object.
+ },
+ "displayName": "A String", # Output only. Display name of the tool.
+ "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse.
+ "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling.
+ "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
+ "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute.
+ "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for.
+ "toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
+ },
+ },
+ "toolResponse": { # The execution result of a specific tool from the client or the agent. # Optional. Tool execution response.
+ "agentName": "A String", # Output only. Human-readable name of the agent that issued this call, e.g. "Contract Architect". Empty when the root agent issued it.
+ "displayName": "A String", # Output only. Display name of the tool.
+ "id": "A String", # Optional. The matching ID of the tool call the response is for.
+ "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling.
+ "response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result.
+ "a_key": "", # Properties of the object.
+ },
+ "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
+ "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed.
+ "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for.
+ "toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
+ },
+ },
+ "transcript": "A String", # Optional. Transcript associated with the audio.
+ "updatedVariables": { # A struct represents variables that were updated in the conversation, keyed by variable names.
+ "a_key": "", # Properties of the object.
+ },
+ },
+ ],
+ "eventTime": "A String", # Optional. Timestamp when the message was sent or received. Should not be used if the message is part of an example.
+ "role": "A String", # Optional. The role within the conversation, e.g., user, agent.
+ },
+ ],
+ "name": "A String", # Identifier. The unique identifier of the example. Format: `projects/{project}/locations/{location}/apps/{app}/examples/{example}`
+ "updateTime": "A String", # Output only. Timestamp when the example was last updated.
+ },
+ ],
+ "guardrails": [ # Optional. List of guardrails in the app.
+ { # Guardrail contains a list of checks and balances to keep the agents safe and secure.
+ "action": { # Action that is taken when a certain precondition is met. # Optional. Action to take when the guardrail is triggered.
+ "generativeAnswer": { # The agent will immediately respond with a generative answer. # Optional. Respond with a generative answer.
+ "prompt": "A String", # Required. The prompt to use for the generative answer.
+ },
+ "respondImmediately": { # The agent will immediately respond with a preconfigured response. # Optional. Immediately respond with a preconfigured response.
+ "responses": [ # Required. The canned responses for the agent to choose from. The response is chosen randomly.
+ { # Represents a response from the agent.
+ "disabled": True or False, # Optional. Whether the response is disabled. Disabled responses are not used by the agent.
+ "text": "A String", # Required. Text for the agent to respond with.
+ },
+ ],
+ },
+ "transferAgent": { # The agent will transfer the conversation to a different agent. # Optional. Transfer the conversation to a different agent.
+ "agent": "A String", # Required. The name of the agent to transfer the conversation to. The agent must be in the same app as the current agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
+ },
+ },
+ "codeCallback": { # Guardrail that blocks the conversation based on the code callbacks provided. # Optional. Guardrail that potentially blocks the conversation based on the result of the callback execution.
+ "afterAgentCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute after the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
+ "description": "A String", # Optional. Human-readable description of the callback.
+ "disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
+ "pythonCode": "A String", # Required. The python code to execute for the callback.
+ },
+ "afterModelCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute after the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
+ "description": "A String", # Optional. Human-readable description of the callback.
+ "disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
+ "pythonCode": "A String", # Required. The python code to execute for the callback.
+ },
+ "beforeAgentCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute before the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
+ "description": "A String", # Optional. Human-readable description of the callback.
+ "disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
+ "pythonCode": "A String", # Required. The python code to execute for the callback.
+ },
+ "beforeModelCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute before the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
+ "description": "A String", # Optional. Human-readable description of the callback.
+ "disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
+ "pythonCode": "A String", # Required. The python code to execute for the callback.
+ },
+ },
+ "contentFilter": { # Guardrail that bans certain content from being used in the conversation. # Optional. Guardrail that bans certain content from being used in the conversation.
+ "bannedContents": [ # Optional. List of banned phrases. Applies to both user inputs and agent responses.
+ "A String",
+ ],
+ "bannedContentsInAgentResponse": [ # Optional. List of banned phrases. Applies only to agent responses.
+ "A String",
+ ],
+ "bannedContentsInUserInput": [ # Optional. List of banned phrases. Applies only to user inputs.
+ "A String",
+ ],
+ "disregardDiacritics": True or False, # Optional. If true, diacritics are ignored during matching.
+ "matchType": "A String", # Required. Match type for the content filter.
+ },
+ "createTime": "A String", # Output only. Timestamp when the guardrail was created.
+ "description": "A String", # Optional. Description of the guardrail.
+ "displayName": "A String", # Required. Display name of the guardrail.
+ "enabled": True or False, # Optional. Whether the guardrail is enabled.
+ "etag": "A String", # Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
+ "llmPolicy": { # Guardrail that blocks the conversation if the LLM response is considered violating the policy based on the LLM classification. # Optional. Guardrail that blocks the conversation if the LLM response is considered violating the policy based on the LLM classification.
+ "allowShortUtterance": True or False, # Optional. By default, the LLM policy check is bypassed for short utterances. Enabling this setting applies the policy check to all utterances, including those that would normally be skipped.
+ "failOpen": True or False, # Optional. If an error occurs during the policy check, fail open and do not trigger the guardrail.
+ "maxConversationMessages": 42, # Optional. When checking this policy, consider the last 'n' messages in the conversation. When not set a default value of 10 will be used.
+ "modelSettings": { # Model settings contains various configurations for the LLM model. # Optional. Model settings.
+ "model": "A String", # Optional. The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
+ "temperature": 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
+ },
+ "policyScope": "A String", # Required. Defines when to apply the policy check during the conversation. If set to `POLICY_SCOPE_UNSPECIFIED`, the policy will be applied to the user input. When applying the policy to the agent response, additional latency will be introduced before the agent can respond.
+ "prompt": "A String", # Required. Policy prompt.
+ },
+ "llmPromptSecurity": { # Guardrail that blocks the conversation if the input is considered unsafe based on the LLM classification. # Optional. Guardrail that blocks the conversation if the prompt is considered unsafe based on the LLM classification.
+ "customPolicy": { # Guardrail that blocks the conversation if the LLM response is considered violating the policy based on the LLM classification. # Optional. Use a user-defined LlmPolicy to configure the security guardrail.
+ "allowShortUtterance": True or False, # Optional. By default, the LLM policy check is bypassed for short utterances. Enabling this setting applies the policy check to all utterances, including those that would normally be skipped.
+ "failOpen": True or False, # Optional. If an error occurs during the policy check, fail open and do not trigger the guardrail.
+ "maxConversationMessages": 42, # Optional. When checking this policy, consider the last 'n' messages in the conversation. When not set a default value of 10 will be used.
+ "modelSettings": { # Model settings contains various configurations for the LLM model. # Optional. Model settings.
+ "model": "A String", # Optional. The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
+ "temperature": 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
+ },
+ "policyScope": "A String", # Required. Defines when to apply the policy check during the conversation. If set to `POLICY_SCOPE_UNSPECIFIED`, the policy will be applied to the user input. When applying the policy to the agent response, additional latency will be introduced before the agent can respond.
+ "prompt": "A String", # Required. Policy prompt.
+ },
+ "defaultSettings": { # Configuration for default system security settings. # Optional. Use the system's predefined default security settings. To select this mode, include an empty 'default_settings' message in the request. The 'default_prompt_template' field within will be populated by the server in the response.
+ "defaultPromptTemplate": "A String", # Output only. The default prompt template used by the system. This field is for display purposes to show the user what prompt the system uses by default. It is OUTPUT_ONLY.
+ },
+ "failOpen": True or False, # Optional. Determines the behavior when the guardrail encounters an LLM error. - If true: the guardrail is bypassed. - If false (default): the guardrail triggers/blocks. Note: If a custom policy is provided, this field is ignored in favor of the policy's 'fail_open' configuration.
+ },
+ "modelSafety": { # Model safety settings overrides. When this is set, it will override the default settings and trigger the guardrail if the response is considered unsafe. # Optional. Guardrail that blocks the conversation if the LLM response is considered unsafe based on the model safety settings.
+ "safetySettings": [ # Required. List of safety settings.
+ { # Safety setting.
+ "category": "A String", # Required. The harm category.
+ "threshold": "A String", # Required. The harm block threshold.
+ },
+ ],
+ },
+ "name": "A String", # Identifier. The unique identifier of the guardrail. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`
+ "updateTime": "A String", # Output only. Timestamp when the guardrail was last updated.
+ },
+ ],
+ "tools": [ # Optional. List of tools in the app.
+ { # A tool represents an action that the CES agent can take to achieve certain goals.
+ "agentTool": { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool.
+ "agent": "A String", # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}`
+ "description": "A String", # Optional. Description of the tool's purpose.
+ "name": "A String", # Required. The name of the agent tool.
+ },
+ "clientFunction": { # Represents a client-side function that the agent can invoke. When the tool is chosen by the agent, control is handed off to the client. The client is responsible for executing the function and returning the result as a ToolResponse to continue the interaction with the agent. # Optional. The client function.
+ "description": "A String", # Optional. The function description.
+ "name": "A String", # Required. The function name.
+ "parameters": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the function parameters.
+ "additionalProperties": # Object with schema name: Schema # 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: Schema
+ ],
+ "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: Schema
+ },
+ "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",
+ ],
+ "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
+ "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+ "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
+ "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+ "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
+ "nullable": True or False, # Optional. Indicates if the value may be null.
+ "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY.
+ # Object with schema name: Schema
+ ],
+ "properties": { # Optional. Properties of Type.OBJECT.
+ "a_key": # Object with schema name: Schema
+ },
+ "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", # Required. The type of the data.
+ "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
+ },
+ "response": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the function response.
+ "additionalProperties": # Object with schema name: Schema # 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: Schema
+ ],
+ "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: Schema
+ },
+ "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",
+ ],
+ "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
+ "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+ "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
+ "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+ "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
+ "nullable": True or False, # Optional. Indicates if the value may be null.
+ "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY.
+ # Object with schema name: Schema
+ ],
+ "properties": { # Optional. Properties of Type.OBJECT.
+ "a_key": # Object with schema name: Schema
+ },
+ "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", # Required. The type of the data.
+ "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
+ },
+ },
+ "connectorTool": { # A ConnectorTool allows connections to different integrations. See: https://cloud.google.com/integration-connectors/docs/overview. # Optional. The Integration Connector tool.
+ "action": { # Configuration of an Action for the tool to use. Note: This can be either an Action or an Operation. See https://cloud.google.com/integration-connectors/docs/entities-operation-action for details. # Required. Action for the tool to use.
+ "connectionActionId": "A String", # ID of a Connection action for the tool to use.
+ "entityOperation": { # Entity CRUD operation specification. # Entity operation configuration for the tool to use.
+ "entityId": "A String", # Required. ID of the entity.
+ "operation": "A String", # Required. Operation to perform on the entity.
+ },
+ "inputFields": [ # Optional. Entity fields to use as inputs for the operation. If no fields are specified, all fields of the Entity will be used.
+ "A String",
+ ],
+ "outputFields": [ # Optional. Entity fields to return from the operation. If no fields are specified, all fields of the Entity will be returned.
+ "A String",
+ ],
+ },
+ "authConfig": { # End-user authentication configuration used for Connection calls. The field values must be the names of context variables in the format `$context.variables.`. # Optional. Configures how authentication is handled in Integration Connectors. By default, an admin authentication is passed in the Integration Connectors API requests. You can override it with a different end-user authentication config. **Note**: The Connection must have authentication override enabled in order to specify an EUC configuration here - otherwise, the ConnectorTool creation will fail. See https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override for details.
+ "oauth2AuthCodeConfig": { # Oauth 2.0 Authorization Code authentication configuration. # Oauth 2.0 Authorization Code authentication.
+ "oauthToken": "A String", # Required. Oauth token parameter name to pass through. Must be in the format `$context.variables.`.
+ },
+ "oauth2JwtBearerConfig": { # JWT Profile Oauth 2.0 Authorization Grant authentication configuration. # JWT Profile Oauth 2.0 Authorization Grant authentication.
+ "clientKey": "A String", # Required. Client parameter name to pass through. Must be in the format `$context.variables.`.
+ "issuer": "A String", # Required. Issuer parameter name to pass through. Must be in the format `$context.variables.`.
+ "subject": "A String", # Required. Subject parameter name to pass through. Must be in the format `$context.variables.`.
+ },
+ },
+ "connection": "A String", # Required. The full resource name of the referenced Integration Connectors Connection. Format: `projects/{project}/locations/{location}/connections/{connection}`
+ "description": "A String", # Optional. The description of the tool that can be used by the Agent to decide whether to call this ConnectorTool.
+ "name": "A String", # Optional. The name of the tool that can be used by the Agent to decide whether to call this ConnectorTool.
+ },
+ "createTime": "A String", # Output only. Timestamp when the tool was created.
+ "dataStoreTool": { # Tool to retrieve from Vertex AI Search datastore or engine for grounding. Accepts either a datastore or an engine, but not both. See Vertex AI Search: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction. # Optional. The data store tool.
+ "boostSpecs": [ # Optional. Boost specification to boost certain documents.
+ { # Boost specifications to boost certain documents. For more information, please refer to https://cloud.google.com/generative-ai-app-builder/docs/boosting.
+ "dataStores": [ # Required. The Data Store where the boosting configuration is applied. Full resource name of DataStore, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}.
+ "A String",
+ ],
+ "spec": [ # Required. A list of boosting specifications.
+ { # Boost specification to boost certain documents.
+ "conditionBoostSpecs": [ # Required. A list of boosting specifications.
+ { # Boost specification for a condition.
+ "boost": 3.14, # Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the suggestions a big promotion. However, it does not necessarily mean that the top result will be a boosted suggestion. Setting to -1.0 gives the suggestions a big demotion. However, other suggestions that are relevant might still be shown. Setting to 0.0 means no boost applied. The boosting condition is ignored.
+ "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Optional. Complex specification for custom ranking based on customer defined attribute value.
+ "attributeType": "A String", # Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).
+ "controlPoints": [ # Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.
+ { # The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).
+ "attributeValue": "A String", # Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.
+ "boostAmount": 3.14, # Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
+ },
+ ],
+ "fieldName": "A String", # Optional. The name of the field whose value will be used to determine the boost amount.
+ "interpolationType": "A String", # Optional. The interpolation type to be applied to connect the control points listed below.
+ },
+ "condition": "A String", # Required. An expression which specifies a boost condition. The syntax is the same as filter expression syntax. Currently, the only supported condition is a list of BCP-47 lang codes. Example: To boost suggestions in languages en or fr: (lang_code: ANY("en", "fr"))
+ },
+ ],
+ },
+ ],
+ },
+ ],
+ "dataStoreSource": { # Configuration for searching within a specific DataStore. # Optional. Search within a single specific DataStore.
+ "dataStore": { # A DataStore resource in Vertex AI Search. # Optional. The data store.
+ "connectorConfig": { # The connector config for the data store connection. # Output only. The connector config for the data store connection.
+ "collection": "A String", # Resource name of the collection the data store belongs to.
+ "collectionDisplayName": "A String", # Display name of the collection the data store belongs to.
+ "dataSource": "A String", # The name of the data source. Example: `salesforce`, `jira`, `confluence`, `bigquery`.
+ },
+ "createTime": "A String", # Output only. Timestamp when the data store was created.
+ "displayName": "A String", # Output only. The display name of the data store.
+ "documentProcessingMode": "A String", # Output only. The document processing mode for the data store connection. Only set for PUBLIC_WEB and UNSTRUCTURED data stores.
+ "name": "A String", # Required. Full resource name of the DataStore. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
+ "type": "A String", # Output only. The type of the data store. This field is readonly and populated by the server.
+ },
+ "filter": "A String", # Optional. Filter specification for the DataStore. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
+ },
+ "description": "A String", # Optional. The tool description.
+ "engineSource": { # Configuration for searching within an Engine, potentially targeting specific DataStores. # Optional. Search within an Engine (potentially across multiple DataStores).
+ "dataStoreSources": [ # Optional. Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine.
+ { # Configuration for searching within a specific DataStore.
+ "dataStore": { # A DataStore resource in Vertex AI Search. # Optional. The data store.
+ "connectorConfig": { # The connector config for the data store connection. # Output only. The connector config for the data store connection.
+ "collection": "A String", # Resource name of the collection the data store belongs to.
+ "collectionDisplayName": "A String", # Display name of the collection the data store belongs to.
+ "dataSource": "A String", # The name of the data source. Example: `salesforce`, `jira`, `confluence`, `bigquery`.
+ },
+ "createTime": "A String", # Output only. Timestamp when the data store was created.
+ "displayName": "A String", # Output only. The display name of the data store.
+ "documentProcessingMode": "A String", # Output only. The document processing mode for the data store connection. Only set for PUBLIC_WEB and UNSTRUCTURED data stores.
+ "name": "A String", # Required. Full resource name of the DataStore. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
+ "type": "A String", # Output only. The type of the data store. This field is readonly and populated by the server.
+ },
+ "filter": "A String", # Optional. Filter specification for the DataStore. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
+ },
+ ],
+ "engine": "A String", # Required. Full resource name of the Engine. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
+ "filter": "A String", # Optional. A filter applied to the search across the Engine. Not relevant and not used if 'data_store_sources' is provided. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
+ },
+ "filterParameterBehavior": "A String", # Optional. The filter parameter behavior.
+ "modalityConfigs": [ # Optional. The modality configs for the data store.
+ { # If specified, will apply the given configuration for the specified modality.
+ "groundingConfig": { # Grounding configuration. # Optional. The grounding configuration.
+ "disabled": True or False, # Optional. Whether grounding is disabled.
+ "groundingLevel": 3.14, # Optional. The groundedness threshold of the answer based on the retrieved sources. The value has a configurable range of [1, 5]. The level is used to threshold the groundedness of the answer, meaning that all responses with a groundedness score below the threshold will fall back to returning relevant snippets only. For example, a level of 3 means that the groundedness score must be 3 or higher for the response to be returned.
+ },
+ "modalityType": "A String", # Required. The modality type.
+ "rewriterConfig": { # Rewriter configuration. # Optional. The rewriter config.
+ "disabled": True or False, # Optional. Whether the rewriter is disabled.
+ "modelSettings": { # Model settings contains various configurations for the LLM model. # Required. Configurations for the LLM model.
+ "model": "A String", # Optional. The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
+ "temperature": 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
+ },
+ "prompt": "A String", # Optional. The prompt definition. If not set, default prompt will be used.
+ },
+ "snippetsConfig": { # Snippets configuration. # Optional. The snippets configuration.
+ "enableSnippets": True or False, # Optional. Whether snippets are enabled.
+ "maxSnippets": 42, # Optional. Number of snippets to return per query. If unset, returns all snippets from the service by default.
+ },
+ "summarizationConfig": { # Summarization configuration. # Optional. The summarization config.
+ "disabled": True or False, # Optional. Whether summarization is disabled.
+ "modelSettings": { # Model settings contains various configurations for the LLM model. # Optional. Configurations for the LLM model.
+ "model": "A String", # Optional. The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
+ "temperature": 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
+ },
+ "prompt": "A String", # Optional. The prompt definition. If not set, default prompt will be used.
+ },
+ },
+ ],
+ "name": "A String", # Required. The data store tool name.
+ },
+ "displayName": "A String", # Output only. The display name of the tool, derived based on the tool's type. For example, display name of a ClientFunction is derived from its `name` property.
+ "etag": "A String", # Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
+ "executionType": "A String", # Optional. The execution type of the tool.
+ "fileSearchTool": { # The file search tool allows the agent to search across the files uploaded by the app/agent developer. It has presets to give relatively good quality search over the uploaded files and summarization of the retrieved results. # Optional. The file search tool.
+ "corpusType": "A String", # Optional. The type of the corpus. Default is FULLY_MANAGED.
+ "description": "A String", # Optional. The tool description.
+ "fileCorpus": "A String", # Optional. The corpus where files are stored. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}
+ "name": "A String", # Required. The tool name.
+ },
+ "generatedSummary": "A String", # Output only. If the tool is generated by the LLM assistant, this field contains a descriptive summary of the generation.
+ "googleSearchTool": { # Represents a tool to perform Google web searches for grounding. See https://cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool#google-search. # Optional. The google search tool.
+ "contextUrls": [ # Optional. Content will be fetched directly from these URLs for context and grounding. Example: "https://example.com/path.html". A maximum of 20 URLs are allowed.
+ "A String",
+ ],
+ "description": "A String", # Optional. Description of the tool's purpose.
+ "excludeDomains": [ # Optional. List of domains to be excluded from the search results. Example: "example.com". A maximum of 2000 domains can be excluded.
+ "A String",
+ ],
+ "name": "A String", # Required. The name of the tool.
+ "preferredDomains": [ # Optional. Specifies domains to restrict search results to. Example: "example.com", "another.site". A maximum of 20 domains can be specified.
+ "A String",
+ ],
+ "promptConfig": { # Prompt settings used by the model when processing or summarizing the google search results. # Optional. Prompt instructions passed to planner on how the search results should be processed for text and voice.
+ "textPrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in chat conversations. If not set, default prompt will be used.
+ "voicePrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in voice conversations. If not set, default prompt will be used.
+ },
+ },
+ "mcpTool": { # An MCP tool. See https://modelcontextprotocol.io/specification/2025-06-18/server/tools for more details. # Optional. The MCP tool. An MCP tool cannot be created or updated directly and is managed by the MCP toolset.
+ "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required to execute the tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication.
+ "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth.
+ "apiKeySecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
+ "requestLocation": "A String", # Required. Key location in the request.
+ },
+ "bearerTokenConfig": { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth.
+ "token": "A String", # Required. The bearer token. Must be in the format `$context.variables.`.
+ },
+ "oauthConfig": { # Configurations for authentication with OAuth. # Optional. Config for OAuth.
+ "clientId": "A String", # Required. The client ID from the OAuth provider.
+ "clientSecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "oauthGrantType": "A String", # Required. OAuth grant types.
+ "scopes": [ # Optional. The OAuth scopes to grant.
+ "A String",
+ ],
+ "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
+ },
+ "serviceAccountAuthConfig": { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication.
+ "scopes": [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.
+ "A String",
+ ],
+ "serviceAccount": "A String", # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ },
+ "serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent.
+ },
+ },
+ "customHeaders": { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details.
+ "a_key": "A String",
+ },
+ "description": "A String", # Optional. The description of the MCP tool.
+ "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the input arguments of the MCP tool.
+ "additionalProperties": # Object with schema name: Schema # 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: Schema
+ ],
+ "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: Schema
+ },
+ "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",
+ ],
+ "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
+ "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+ "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
+ "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+ "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
+ "nullable": True or False, # Optional. Indicates if the value may be null.
+ "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY.
+ # Object with schema name: Schema
+ ],
+ "properties": { # Optional. Properties of Type.OBJECT.
+ "a_key": # Object with schema name: Schema
+ },
+ "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", # Required. The type of the data.
+ "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
+ },
+ "name": "A String", # Required. The name of the MCP tool.
+ "nameOverride": "A String", # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override.
+ "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool.
+ "additionalProperties": # Object with schema name: Schema # 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: Schema
+ ],
+ "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: Schema
+ },
+ "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",
+ ],
+ "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
+ "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+ "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
+ "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+ "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
+ "nullable": True or False, # Optional. Indicates if the value may be null.
+ "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY.
+ # Object with schema name: Schema
+ ],
+ "properties": { # Optional. Properties of Type.OBJECT.
+ "a_key": # Object with schema name: Schema
+ },
+ "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", # Required. The type of the data.
+ "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
+ },
+ "serverAddress": "A String", # Required. The server address of the MCP server, e.g., "https://example.com/mcp/". If the server is built with the MCP SDK, the url should be suffixed with "/mcp/". Only Streamable HTTP transport based servers are supported. This is the same as the server_address in the McpToolset. See https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http for more details.
+ "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter.
+ "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.
+ },
+ "state": "A String", # Output only. The dynamic availability state of the tool on the external server.
+ "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust.
+ "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
+ { # The CA certificate.
+ "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ```
+ "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
+ },
+ ],
+ },
+ },
+ "name": "A String", # Identifier. The resource name of the tool. Format: * `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for standalone tools. * `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only; they cannot be referenced directly where a tool is expected.
+ "openApiTool": { # A remote API tool defined by an OpenAPI schema. # Optional. The open API tool.
+ "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required by the API.
+ "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth.
+ "apiKeySecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
+ "requestLocation": "A String", # Required. Key location in the request.
+ },
+ "bearerTokenConfig": { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth.
+ "token": "A String", # Required. The bearer token. Must be in the format `$context.variables.`.
+ },
+ "oauthConfig": { # Configurations for authentication with OAuth. # Optional. Config for OAuth.
+ "clientId": "A String", # Required. The client ID from the OAuth provider.
+ "clientSecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "oauthGrantType": "A String", # Required. OAuth grant types.
+ "scopes": [ # Optional. The OAuth scopes to grant.
+ "A String",
+ ],
+ "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
+ },
+ "serviceAccountAuthConfig": { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication.
+ "scopes": [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.
+ "A String",
+ ],
+ "serviceAccount": "A String", # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ },
+ "serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent.
+ },
+ },
+ "description": "A String", # Optional. The description of the tool. If not provided, the description of the tool will be derived from the OpenAPI schema, from `operation.description` or `operation.summary`.
+ "ignoreUnknownFields": True or False, # Optional. If true, the agent will ignore unknown fields in the API response.
+ "name": "A String", # Optional. The name of the tool. If not provided, the name of the tool will be derived from the OpenAPI schema, from `operation.operationId`.
+ "openApiSchema": "A String", # Required. The OpenAPI schema in JSON or YAML format.
+ "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration.
+ "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.
+ },
+ "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client will trust.
+ "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
+ { # The CA certificate.
+ "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ```
+ "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
+ },
+ ],
+ },
+ "url": "A String", # Optional. The server URL of the Open API schema. This field is only set in tools in the environment dependencies during the export process if the schema contains a server url. During the import process, if this url is present in the environment dependencies and the schema has the $env_var placeholder, it will replace the placeholder in the schema.
+ },
+ "pythonFunction": { # A Python function tool. # Optional. The python function tool.
+ "description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring.
+ "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used.
+ "pythonCode": "A String", # Optional. The Python code to execute for the tool.
+ "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool.
+ "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.
+ },
+ },
+ "remoteAgentTool": { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool.
+ "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes.
+ "description": "A String", # Required. A description of the agent's domain of action/solution space.
+ "name": "A String", # Required. A human-readable name for the agent.
+ "skills": [ # Required. Skills represent a unit of ability an agent can perform. This may somewhat abstract but represents a more focused set of actions that the agent is highly likely to succeed at.
+ { # Represents a distinct capability or function that an agent can perform.
+ "description": "A String", # Required. A detailed description of the skill.
+ "examples": [ # Example prompts or scenarios that this skill can handle.
+ "A String",
+ ],
+ "id": "A String", # Required. A unique identifier for the agent's skill.
+ "inputModes": [ # The set of supported input media types for this skill, overriding the agent's defaults.
+ "A String",
+ ],
+ "name": "A String", # Required. A human-readable name for the skill.
+ "outputModes": [ # The set of supported output media types for this skill, overriding the agent's defaults.
+ "A String",
+ ],
+ "tags": [ # Required. A set of keywords describing the skill's capabilities.
+ "A String",
+ ],
+ },
+ ],
+ "supportedInterfaces": [ # Required. Ordered list of supported interfaces. The first entry is preferred.
+ { # Declares a combination of a target URL, transport and protocol version for interacting with the agent. This allows agents to expose the same functionality over multiple protocol binding mechanisms.
+ "protocolBinding": "A String", # Required. The protocol binding supported at this URL. This is an open form string, to be easily extended for other protocol bindings. The core ones officially supported are `JSONRPC`, `GRPC` and `HTTP+JSON`.
+ "protocolVersion": "A String", # Required. The version of the A2A protocol this interface exposes. Use the latest supported minor version per major version. Examples: "0.3", "1.0"
+ "tenant": "A String", # Tenant ID to be used in the request when calling the agent.
+ "url": "A String", # Required. The URL where this interface is available. Must be a valid absolute HTTPS URL in production. Example: "https://api.example.com/a2a/v1", "https://grpc.example.com/a2a"
+ },
+ ],
+ "version": "A String", # Required. The version of the agent.
+ },
+ "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication configuration for calling the remote agent.
+ "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth.
+ "apiKeySecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
+ "requestLocation": "A String", # Required. Key location in the request.
+ },
+ "bearerTokenConfig": { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth.
+ "token": "A String", # Required. The bearer token. Must be in the format `$context.variables.`.
+ },
+ "oauthConfig": { # Configurations for authentication with OAuth. # Optional. Config for OAuth.
+ "clientId": "A String", # Required. The client ID from the OAuth provider.
+ "clientSecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "oauthGrantType": "A String", # Required. OAuth grant types.
+ "scopes": [ # Optional. The OAuth scopes to grant.
+ "A String",
+ ],
+ "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
+ },
+ "serviceAccountAuthConfig": { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication.
+ "scopes": [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.
+ "A String",
+ ],
+ "serviceAccount": "A String", # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ },
+ "serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent.
+ },
+ },
+ "description": "A String", # Required. The description of the tool.
+ "name": "A String", # Required. The name of the tool.
+ },
+ "systemTool": { # Pre-defined system tool. # Optional. The system tool.
+ "description": "A String", # Output only. The description of the system tool.
+ "name": "A String", # Required. The name of the system tool.
+ },
+ "timeout": "A String", # Optional. The timeout for the tool execution. If not set, the default timeout is 30 seconds for `SYNCHRONOUS` tools and 60 seconds for `ASYNCHRONOUS` tools.
+ "toolFakeConfig": { # Configuration for tool behavior in fake mode. # Optional. Configuration for tool behavior in fake mode.
+ "codeBlock": { # A code block to be executed instead of a real tool call. # Optional. Code block which will be executed instead of a real tool call.
+ "pythonCode": "A String", # Required. Python code which will be invoked in tool fake mode. Expected Python function signature - To catch all tool calls: def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: To catch a specific tool call: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: If the function returns None, the real tool will be invoked instead.
+ },
+ "enableFakeMode": True or False, # Optional. Whether the tool is using fake mode.
+ },
+ "updateTime": "A String", # Output only. Timestamp when the tool was last updated.
+ "widgetTool": { # Represents a widget tool that the agent can invoke. When the tool is chosen by the agent, agent will return the widget to the client. The client is responsible for processing the widget and generating the next user query to continue the interaction with the agent. # Optional. The widget tool.
+ "dataMapping": { # Configuration for mapping data from a source tool to the widget's input parameters. # Optional. The mapping that defines how data from a source tool is mapped to the widget's input parameters.
+ "fieldMappings": { # Optional. A map of widget input parameter fields to the corresponding output fields of the source tool.
+ "a_key": "A String",
+ },
+ "mode": "A String", # Optional. The mode of the data mapping.
+ "pythonFunction": { # A Python function tool. # Optional. Configuration for a Python function used to transform the source tool's output into the widget's input format.
+ "description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring.
+ "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used.
+ "pythonCode": "A String", # Optional. The Python code to execute for the tool.
+ "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool.
+ "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.
+ },
+ },
+ "pythonScript": "A String", # Deprecated: Use `python_function` instead.
+ "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}`
+ },
+ "description": "A String", # Optional. The description of the widget tool.
+ "name": "A String", # Required. The display name of the widget tool.
+ "parameters": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The input parameters of the widget tool.
+ "additionalProperties": # Object with schema name: Schema # 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: Schema
+ ],
+ "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: Schema
+ },
+ "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",
+ ],
+ "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
+ "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+ "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
+ "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+ "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
+ "nullable": True or False, # Optional. Indicates if the value may be null.
+ "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY.
+ # Object with schema name: Schema
+ ],
+ "properties": { # Optional. Properties of Type.OBJECT.
+ "a_key": # Object with schema name: Schema
+ },
+ "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", # Required. The type of the data.
+ "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
+ },
+ "textResponseConfig": { # Configuration for the text response returned with the widget. # Optional. Configuration for always-included text responses.
+ "staticText": "A String", # Optional. The static text response to return when type is STATIC.
+ "textResponseInstruction": "A String", # Optional. Instruction for the LLM on how to generate the text response. Used as the description for the text response parameter if type is LLM_GENERATED.
+ "type": "A String", # Optional. The strategy for providing the text response.
+ },
+ "uiConfig": { # Optional. Configuration for rendering the widget.
+ "a_key": "", # Properties of the object.
+ },
+ "widgetType": "A String", # Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED.
+ },
+ },
+ ],
+ "toolsets": [ # Optional. List of toolsets in the app.
+ { # A toolset represents a group of dynamically managed tools that can be used by the agent.
+ "connectorToolset": { # A toolset that generates tools from an Integration Connectors Connection. # Optional. A toolset that generates tools from an Integration Connectors Connection.
+ "authConfig": { # End-user authentication configuration used for Connection calls. The field values must be the names of context variables in the format `$context.variables.`. # Optional. Configures how authentication is handled in Integration Connectors. By default, an admin authentication is passed in the Integration Connectors API requests. You can override it with a different end-user authentication config. **Note**: The Connection must have authentication override enabled in order to specify an EUC configuration here - otherwise, the Toolset creation will fail. See: https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override
+ "oauth2AuthCodeConfig": { # Oauth 2.0 Authorization Code authentication configuration. # Oauth 2.0 Authorization Code authentication.
+ "oauthToken": "A String", # Required. Oauth token parameter name to pass through. Must be in the format `$context.variables.`.
+ },
+ "oauth2JwtBearerConfig": { # JWT Profile Oauth 2.0 Authorization Grant authentication configuration. # JWT Profile Oauth 2.0 Authorization Grant authentication.
+ "clientKey": "A String", # Required. Client parameter name to pass through. Must be in the format `$context.variables.`.
+ "issuer": "A String", # Required. Issuer parameter name to pass through. Must be in the format `$context.variables.`.
+ "subject": "A String", # Required. Subject parameter name to pass through. Must be in the format `$context.variables.`.
+ },
+ },
+ "connection": "A String", # Required. The full resource name of the referenced Integration Connectors Connection. Format: `projects/{project}/locations/{location}/connections/{connection}`
+ "connectorActions": [ # Required. The list of connector actions/entity operations to generate tools for.
+ { # Configuration of an Action for the tool to use. Note: This can be either an Action or an Operation. See https://cloud.google.com/integration-connectors/docs/entities-operation-action for details.
+ "connectionActionId": "A String", # ID of a Connection action for the tool to use.
+ "entityOperation": { # Entity CRUD operation specification. # Entity operation configuration for the tool to use.
+ "entityId": "A String", # Required. ID of the entity.
+ "operation": "A String", # Required. Operation to perform on the entity.
+ },
+ "inputFields": [ # Optional. Entity fields to use as inputs for the operation. If no fields are specified, all fields of the Entity will be used.
+ "A String",
+ ],
+ "outputFields": [ # Optional. Entity fields to return from the operation. If no fields are specified, all fields of the Entity will be returned.
+ "A String",
+ ],
+ },
+ ],
+ },
+ "createTime": "A String", # Output only. Timestamp when the toolset was created.
+ "description": "A String", # Optional. The description of the toolset.
+ "displayName": "A String", # Optional. The display name of the toolset. Must be unique within the same app.
+ "etag": "A String", # ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
+ "executionType": "A String", # Optional. The execution type of the tools in the toolset.
+ "mcpToolset": { # A toolset that contains a list of tools that are offered by the MCP server. # Optional. A toolset that contains a list of tools that are offered by the MCP server.
+ "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required to access tools and execute a tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication.
+ "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth.
+ "apiKeySecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
+ "requestLocation": "A String", # Required. Key location in the request.
+ },
+ "bearerTokenConfig": { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth.
+ "token": "A String", # Required. The bearer token. Must be in the format `$context.variables.`.
+ },
+ "oauthConfig": { # Configurations for authentication with OAuth. # Optional. Config for OAuth.
+ "clientId": "A String", # Required. The client ID from the OAuth provider.
+ "clientSecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "oauthGrantType": "A String", # Required. OAuth grant types.
+ "scopes": [ # Optional. The OAuth scopes to grant.
+ "A String",
+ ],
+ "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
+ },
+ "serviceAccountAuthConfig": { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication.
+ "scopes": [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.
+ "A String",
+ ],
+ "serviceAccount": "A String", # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ },
+ "serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent.
+ },
+ },
+ "customHeaders": { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details.
+ "a_key": "A String",
+ },
+ "serverAddress": "A String", # Required. The address of the MCP server, for example, "https://example.com/mcp/". If the server is built with the MCP SDK, the url should be suffixed with "/mcp/". Only Streamable HTTP transport based servers are supported. See https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http for more details.
+ "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter.
+ "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.
+ },
+ "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust.
+ "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
+ { # The CA certificate.
+ "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ```
+ "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
+ },
+ ],
+ },
+ "toolOverrides": [ # Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic.
+ { # Overrides associated with a given tool in a Toolset. This enables "pinning" or "overriding" of tool definitions from the external dynamic server.
+ "descriptionOverride": "A String", # Optional. If present, this tool uses this description instead of the original description from the server.
+ "nameOverride": "A String", # Optional. If present, this tool uses this name in the Agent instead of the original name. This is primarily used as an alias if the MCP server offers poorly named tools.
+ "snapshot": { # Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden. # Output only. If present, this tool is "Pinned" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present.
+ "description": "A String", # Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`.
+ "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the input arguments of the MCP tool.
+ "additionalProperties": # Object with schema name: Schema # 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: Schema
+ ],
+ "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: Schema
+ },
+ "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",
+ ],
+ "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
+ "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+ "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
+ "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+ "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
+ "nullable": True or False, # Optional. Indicates if the value may be null.
+ "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY.
+ # Object with schema name: Schema
+ ],
+ "properties": { # Optional. Properties of Type.OBJECT.
+ "a_key": # Object with schema name: Schema
+ },
+ "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", # Required. The type of the data.
+ "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
+ },
+ "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the output arguments of the MCP tool.
+ "additionalProperties": # Object with schema name: Schema # 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: Schema
+ ],
+ "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: Schema
+ },
+ "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",
+ ],
+ "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
+ "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+ "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
+ "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+ "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
+ "nullable": True or False, # Optional. Indicates if the value may be null.
+ "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY.
+ # Object with schema name: Schema
+ ],
+ "properties": { # Optional. Properties of Type.OBJECT.
+ "a_key": # Object with schema name: Schema
+ },
+ "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", # Required. The type of the data.
+ "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
+ },
+ },
+ "tool": "A String", # Required. The original name of the tool as it is emitted by the MCP server.
+ },
+ ],
+ },
+ "name": "A String", # Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
+ "openApiToolset": { # A toolset that contains a list of tools that are defined by an OpenAPI schema. # Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema.
+ "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required by the API.
+ "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth.
+ "apiKeySecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
+ "requestLocation": "A String", # Required. Key location in the request.
+ },
+ "bearerTokenConfig": { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth.
+ "token": "A String", # Required. The bearer token. Must be in the format `$context.variables.`.
+ },
+ "oauthConfig": { # Configurations for authentication with OAuth. # Optional. Config for OAuth.
+ "clientId": "A String", # Required. The client ID from the OAuth provider.
+ "clientSecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "oauthGrantType": "A String", # Required. OAuth grant types.
+ "scopes": [ # Optional. The OAuth scopes to grant.
+ "A String",
+ ],
+ "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
+ },
+ "serviceAccountAuthConfig": { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication.
+ "scopes": [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.
+ "A String",
+ ],
+ "serviceAccount": "A String", # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ },
+ "serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent.
+ },
+ },
+ "ignoreUnknownFields": True or False, # Optional. If true, the agent will ignore unknown fields in the API response for all operations defined in the OpenAPI schema.
+ "openApiSchema": "A String", # Required. The OpenAPI schema of the toolset.
+ "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration.
+ "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.
+ },
+ "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates
+ "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
+ { # The CA certificate.
+ "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ```
+ "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
+ },
+ ],
+ },
+ "url": "A String", # Optional. The server URL of the Open API schema. This field is only set in toolsets in the environment dependencies during the export process if the schema contains a server url. During the import process, if this url is present in the environment dependencies and the schema has the $env_var placeholder, it will replace the placeholder in the schema.
+ },
+ "timeout": "A String", # Optional. The timeout for the toolset execution. If not set, the default timeout is 30 seconds for `SYNCHRONOUS` toolsets and 60 seconds for `ASYNCHRONOUS` toolsets.
+ "toolFakeConfig": { # Configuration for tool behavior in fake mode. # Optional. Configuration for tools behavior in fake mode.
+ "codeBlock": { # A code block to be executed instead of a real tool call. # Optional. Code block which will be executed instead of a real tool call.
+ "pythonCode": "A String", # Required. Python code which will be invoked in tool fake mode. Expected Python function signature - To catch all tool calls: def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: To catch a specific tool call: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: If the function returns None, the real tool will be invoked instead.
+ },
+ "enableFakeMode": True or False, # Optional. Whether the tool is using fake mode.
+ },
+ "updateTime": "A String", # Output only. Timestamp when the toolset was last updated.
+ },
+ ],
+ },
+ "updateTime": "A String", # Output only. Timestamp when the app version was last updated.
+}
+
+ updateMask: string, Optional. The list of fields to update. If empty, fields `display_name` and `description` will be updated.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # In Customer Engagement Suite (CES), an app version is a snapshot of the app at a specific point in time. It is immutable and cannot be modified once created.
+ "createTime": "A String", # Output only. Timestamp when the app version was created.
+ "creator": "A String", # Output only. Email of the user who created the app version.
+ "description": "A String", # Optional. The description of the app version.
+ "displayName": "A String", # Optional. The display name of the app version.
+ "etag": "A String", # Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
+ "name": "A String", # Identifier. The unique identifier of the app version. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`
+ "snapshot": { # A snapshot of the app. # Output only. The snapshot of the app when the version is created.
+ "agents": [ # Optional. List of agents in the app.
+ { # An agent acts as the fundamental building block that provides instructions to the Large Language Model (LLM) for executing specific tasks.
+ "afterAgentCallbacks": [ # Optional. The callbacks to execute after the agent is called. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.
+ { # A callback defines the custom logic to be executed at various stages of agent interaction.
+ "description": "A String", # Optional. Human-readable description of the callback.
+ "disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
+ "pythonCode": "A String", # Required. The python code to execute for the callback.
+ },
+ ],
+ "afterModelCallbacks": [ # Optional. The callbacks to execute after the model is called. If there are multiple calls to the model, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.
+ { # A callback defines the custom logic to be executed at various stages of agent interaction.
+ "description": "A String", # Optional. Human-readable description of the callback.
+ "disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
+ "pythonCode": "A String", # Required. The python code to execute for the callback.
+ },
+ ],
+ "afterToolCallbacks": [ # Optional. The callbacks to execute after the tool is invoked. If there are multiple tool invocations, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.
+ { # A callback defines the custom logic to be executed at various stages of agent interaction.
+ "description": "A String", # Optional. Human-readable description of the callback.
+ "disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
+ "pythonCode": "A String", # Required. The python code to execute for the callback.
+ },
+ ],
+ "beforeAgentCallbacks": [ # Optional. The callbacks to execute before the agent is called. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.
+ { # A callback defines the custom logic to be executed at various stages of agent interaction.
+ "description": "A String", # Optional. Human-readable description of the callback.
+ "disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
+ "pythonCode": "A String", # Required. The python code to execute for the callback.
+ },
+ ],
+ "beforeModelCallbacks": [ # Optional. The callbacks to execute before the model is called. If there are multiple calls to the model, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.
+ { # A callback defines the custom logic to be executed at various stages of agent interaction.
+ "description": "A String", # Optional. Human-readable description of the callback.
+ "disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
+ "pythonCode": "A String", # Required. The python code to execute for the callback.
+ },
+ ],
+ "beforeToolCallbacks": [ # Optional. The callbacks to execute before the tool is invoked. If there are multiple tool invocations, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped.
+ { # A callback defines the custom logic to be executed at various stages of agent interaction.
+ "description": "A String", # Optional. Human-readable description of the callback.
+ "disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
+ "pythonCode": "A String", # Required. The python code to execute for the callback.
+ },
+ ],
+ "childAgents": [ # Optional. List of child agents in the agent tree. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
+ "A String",
+ ],
+ "createTime": "A String", # Output only. Timestamp when the agent was created.
+ "description": "A String", # Optional. Human-readable description of the agent.
+ "displayName": "A String", # Required. Display name of the agent.
+ "etag": "A String", # Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
+ "generatedSummary": "A String", # Output only. If the agent is generated by the LLM assistant, this field contains a descriptive summary of the generation.
+ "guardrails": [ # Optional. List of guardrails for the agent. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`
+ "A String",
+ ],
+ "instruction": "A String", # Optional. Instructions for the LLM model to guide the agent's behavior.
+ "llmAgent": { # Default agent type. The agent uses instructions and callbacks specified in the agent to perform the task using a large language model. # Optional. The default agent type.
+ },
+ "modelSettings": { # Model settings contains various configurations for the LLM model. # Optional. Configurations for the LLM model.
+ "model": "A String", # Optional. The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
+ "temperature": 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
+ },
+ "name": "A String", # Identifier. The unique identifier of the agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
+ "remoteA2aAgent": { # The agent which will transfer execution to a remote [A2A](https://github.com/a2aproject/A2A) agent. # Optional. The remote [A2A](https://github.com/a2aproject/A2A) agent to be used for the agent execution.
+ "a2aConfig": { # Shared configuration for connecting to a remote [A2A](https://github.com/a2aproject/A2A) agent. # Required. The A2A connection configuration.
+ "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Optional. The full agent card defined inline.
+ "description": "A String", # Required. A description of the agent's domain of action/solution space.
+ "name": "A String", # Required. A human-readable name for the agent.
+ "skills": [ # Required. Skills represent a unit of ability an agent can perform. This may somewhat abstract but represents a more focused set of actions that the agent is highly likely to succeed at.
+ { # Represents a distinct capability or function that an agent can perform.
+ "description": "A String", # Required. A detailed description of the skill.
+ "examples": [ # Example prompts or scenarios that this skill can handle.
+ "A String",
+ ],
+ "id": "A String", # Required. A unique identifier for the agent's skill.
+ "inputModes": [ # The set of supported input media types for this skill, overriding the agent's defaults.
+ "A String",
+ ],
+ "name": "A String", # Required. A human-readable name for the skill.
+ "outputModes": [ # The set of supported output media types for this skill, overriding the agent's defaults.
+ "A String",
+ ],
+ "tags": [ # Required. A set of keywords describing the skill's capabilities.
+ "A String",
+ ],
+ },
+ ],
+ "supportedInterfaces": [ # Required. Ordered list of supported interfaces. The first entry is preferred.
+ { # Declares a combination of a target URL, transport and protocol version for interacting with the agent. This allows agents to expose the same functionality over multiple protocol binding mechanisms.
+ "protocolBinding": "A String", # Required. The protocol binding supported at this URL. This is an open form string, to be easily extended for other protocol bindings. The core ones officially supported are `JSONRPC`, `GRPC` and `HTTP+JSON`.
+ "protocolVersion": "A String", # Required. The version of the A2A protocol this interface exposes. Use the latest supported minor version per major version. Examples: "0.3", "1.0"
+ "tenant": "A String", # Tenant ID to be used in the request when calling the agent.
+ "url": "A String", # Required. The URL where this interface is available. Must be a valid absolute HTTPS URL in production. Example: "https://api.example.com/a2a/v1", "https://grpc.example.com/a2a"
+ },
+ ],
+ "version": "A String", # Required. The version of the agent.
+ },
+ "agentRegistry": "A String", # Optional. Reference to the agent in the Agent Registry. Format: `projects/{project}/locations/{location}/agents/{agent}`
+ "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication configuration for calling the remote agent. Optional if the registry reference already handles authentication.
+ "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth.
+ "apiKeySecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
+ "requestLocation": "A String", # Required. Key location in the request.
+ },
+ "bearerTokenConfig": { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth.
+ "token": "A String", # Required. The bearer token. Must be in the format `$context.variables.`.
+ },
+ "oauthConfig": { # Configurations for authentication with OAuth. # Optional. Config for OAuth.
+ "clientId": "A String", # Required. The client ID from the OAuth provider.
+ "clientSecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "oauthGrantType": "A String", # Required. OAuth grant types.
+ "scopes": [ # Optional. The OAuth scopes to grant.
+ "A String",
+ ],
+ "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
+ },
+ "serviceAccountAuthConfig": { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication.
+ "scopes": [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.
+ "A String",
+ ],
+ "serviceAccount": "A String", # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ },
+ "serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent.
+ },
+ },
+ "contextId": "A String", # Optional. If not empty, interactions with the remote A2A agent will use this context ID. This context_id field can refer to a session variable like `$context.variables.order_agent_session_id`.
+ "inputVariableMapping": { # Optional. Mapping of input variable names of remote agent to GECX variable names.
+ "a_key": "A String",
+ },
+ "outputVariableMapping": { # Optional. Mapping of output variable names of remote agent to GECX variable names.
+ "a_key": "A String",
+ },
+ "streamingEnabled": True or False, # Optional. Whether streaming is enabled for the remote agent.
+ },
+ },
+ "remoteDialogflowAgent": { # The agent which will transfer execution to a remote [Dialogflow CX](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent. The Dialogflow agent will process subsequent user queries until the session ends or flow ends, and the control is transferred back to the parent CES agent. # Optional. The remote [Dialogflow](https://cloud.google.com/dialogflow/cx/docs/concept/console-conversational-agents) agent to be used for the agent execution. If this field is set, all other agent level properties will be ignored. Note: If the Dialogflow agent is in a different project from the app, you should grant `roles/dialogflow.client` to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "agent": "A String", # Required. The [Dialogflow](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent resource name. Format: `projects/{project}/locations/{location}/agents/{agent}`
+ "environmentId": "A String", # Optional. The environment ID of the Dialogflow agent to be used for the agent execution. If not specified, the draft environment will be used.
+ "flowId": "A String", # Optional. The flow ID of the flow in the Dialogflow agent.
+ "inputVariableMapping": { # Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input.
+ "a_key": "A String",
+ },
+ "languageCodeVariable": "A String", # Optional. The name of the variable that contains the language code to be used for the Dialogflow session. If unspecified, the default language code of the Dialogflow agent will be used.
+ "outputVariableMapping": { # Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends.
+ "a_key": "A String",
+ },
+ "respectResponseInterruptionSettings": True or False, # Optional. Indicates whether to respect the message-level interruption settings configured in the Dialogflow agent. * If false: all response messages from the Dialogflow agent follow the app-level barge-in settings. * If true: only response messages with [`allow_playback_interruption`](https://docs.cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#text) set to true will be interruptable, all other messages follow the app-level barge-in settings.
+ },
+ "tools": [ # Optional. List of available tools for the agent. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
+ "A String",
+ ],
+ "toolsets": [ # Optional. List of toolsets for the agent.
+ { # A toolset with a selection of its tools.
+ "toolIds": [ # Optional. The tools IDs to filter the toolset.
+ "A String",
+ ],
+ "toolset": "A String", # Required. The resource name of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
+ },
+ ],
+ "transferRules": [ # Optional. Agent transfer rules. If multiple rules match, the first one in the list will be used.
+ { # Rule for transferring to a specific agent.
+ "childAgent": "A String", # Required. The resource name of the child agent the rule applies to. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
+ "deterministicTransfer": { # Deterministic transfer rule. When the condition evaluates to true, the transfer occurs. # Optional. A rule that immediately transfers to the target agent when the condition is met.
+ "expressionCondition": { # Expression condition based on session state. # Optional. A rule that evaluates a session state condition. If the condition evaluates to true, the transfer occurs.
+ "expression": "A String", # Required. The string representation of cloud.api.Expression condition.
+ },
+ "pythonCodeCondition": { # Python code block to evaluate the condition. # Optional. A rule that uses Python code block to evaluate the conditions. If the condition evaluates to true, the transfer occurs.
+ "pythonCode": "A String", # Required. The python code to execute.
+ },
+ },
+ "direction": "A String", # Required. The direction of the transfer.
+ "disablePlannerTransfer": { # A rule that prevents the planner from transferring to the target agent. # Optional. Rule that prevents the planner from transferring to the target agent.
+ "expressionCondition": { # Expression condition based on session state. # Required. If the condition evaluates to true, planner will not be allowed to transfer to the target agent.
+ "expression": "A String", # Required. The string representation of cloud.api.Expression condition.
+ },
+ },
+ },
+ ],
+ "updateTime": "A String", # Output only. Timestamp when the agent was last updated.
+ "validationErrors": [ # Output only. Misconfigurations or errors in the agent that may affect agent quality.
+ "A String",
+ ],
+ },
+ ],
+ "app": { # An app serves as a top-level container for a group of agents, including the root agent and its sub-agents, along with their associated configurations. These agents work together to achieve specific goals within the app's context. # Optional. The basic settings for the app.
+ "audioProcessingConfig": { # Configuration for how the input and output audio should be processed and delivered. # Optional. Audio processing configuration of the app.
+ "ambientSoundConfig": { # Configuration for the ambient sound to be played with the synthesized agent response, to enhance the naturalness of the conversation. # Optional. Configuration for the ambient sound to be played with the synthesized agent response, to enhance the naturalness of the conversation.
+ "gcsUri": "A String", # Optional. Ambient noise as a mono-channel, 16kHz WAV file stored in [Cloud Storage](https://cloud.google.com/storage). Note: Please make sure the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com` has `storage.objects.get` permission to the Cloud Storage object.
+ "prebuiltAmbientNoise": "A String", # Optional. Deprecated: `prebuilt_ambient_noise` is deprecated in favor of `prebuilt_ambient_sound`.
+ "prebuiltAmbientSound": "A String", # Optional. Name of the prebuilt ambient sound. Valid values are: - "coffee_shop" - "keyboard" - "keypad" - "hum" - "office_1" - "office_2" - "office_3" - "room_1" - "room_2" - "room_3" - "room_4" - "room_5" - "air_conditioner"
+ "volumeGainDb": 3.14, # Optional. Volume gain (in dB) of the normal native volume supported by ambient noise, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.
+ },
+ "bargeInConfig": { # Configuration for how the user barge-in activities should be handled. # Optional. Configures the agent behavior for the user barge-in activities.
+ "bargeInAwareness": True or False, # Optional. If enabled, the agent will adapt its next response based on the assumption that the user hasn't heard the full preceding agent message. This should not be used in scenarios where agent responses are displayed visually.
+ "disableBargeIn": True or False, # Optional. Deprecated: `disable_barge_in` is deprecated in favor of `disable_barge_in_control` in ChannelProfile. Disables user barge-in while the agent is speaking. If true, user input during agent response playback will be ignored.
+ },
+ "customVoiceSamples": [ # Optional. Configures custom voice samples for voice cloning.
+ { # Configuration for a custom voice sample used for voice cloning.
+ "consentAudioGcsUri": "A String", # Optional. Consent audio for voice cloning.
+ "name": "A String", # Optional. The user-defined name for the custom voice sample.
+ "previewAudioContent": "A String", # Output only. Synthesized preview audio for custom voice, formatted as canonical WAV (LINEAR16, 24kHz, 16-bit, mono).
+ "previewText": "A String", # Optional. Text for synthesizing preview audio for custom voice.
+ "voiceInstruction": "A String", # Optional. Natural language instructions for voice style, tone, pacing, or pronunciation.
+ "voiceSampleGcsUri": "A String", # Optional. The Cloud Storage URI to the audio sample for voice cloning. The audio sample should be a mono-channel, 24kHz WAV file.
+ },
+ ],
+ "inactivityTimeout": "A String", # Optional. The duration of user inactivity (no speech or interaction) before the agent prompts the user for reengagement. If not set, the agent will not prompt the user for reengagement.
+ "synthesizeSpeechConfigs": { # Optional. Configuration of how the agent response should be synthesized, mapping from the language code to SynthesizeSpeechConfig. If the configuration for the specified language code is not found, the configuration for the root language code will be used. For example, if the map contains "en-us" and "en", and the specified language code is "en-gb", then "en" configuration will be used. Note: Language code is case-insensitive.
+ "a_key": { # Configuration for how the agent response should be synthesized.
+ "consentAudioGcsUri": "A String", # Optional. Deprecated: Use `custom_voice_samples` in AudioProcessingConfig instead. The Cloud Storage URI to the consent audio for voice cloning.
+ "instruction": "A String", # Optional. The instruction used to synthesize speech when using a generative model.
+ "model": "A String", # Optional. The model used to synthesize audio. Currently supported values: - "gemini-3.1-flash-tts-preview" If empty, Chirp3-HD is used.
+ "speakingRate": 3.14, # Optional. The speaking rate/speed in the range [0.25, 2.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. Values outside of the range [0.25, 2.0] will return an error.
+ "voice": "A String", # Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices) from Cloud Text-to-Speech.
+ "voiceSampleGcsUri": "A String", # Optional. Deprecated: Use `custom_voice_samples` in AudioProcessingConfig instead. The Cloud Storage URI to the audio sample for voice cloning. The audio sample should be a mono-channel, 24kHz WAV file. Note: Please make sure the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com` has `storage.objects.get` permission to the Cloud Storage object.
+ },
+ },
+ },
+ "clientCertificateSettings": { # Settings for custom client certificates. # Optional. The default client certificate settings for the app.
+ "passphrase": "A String", # Optional. The name of the SecretManager secret version resource storing the passphrase to decrypt the private key. Should be left unset if the private key is not encrypted. Format: `projects/{project}/secrets/{secret}/versions/{version}`
+ "privateKey": "A String", # Required. The name of the SecretManager secret version resource storing the private key encoded in PEM format. Format: `projects/{project}/secrets/{secret}/versions/{version}`
+ "tlsCertificate": "A String", # Required. The TLS certificate encoded in PEM format. This string must include the begin header and end footer lines.
+ },
+ "createTime": "A String", # Output only. Timestamp when the app was created.
+ "dashboardSettings": { # Settings for dashboards associated with the app, that show up in the Monitoring view. # Optional. App-specific dashboard settings for linking and configuring Contact Center Insights dashboards.
+ "defaultDashboard": "A String", # Optional. The resource name of the default Contact Center Insights dashboard associated with the app. This is the dashboard that will be displayed when users navigate to the Monitoring view for the app. Format: `projects/{project}/locations/{location}/dashboards/{dashboard}`
+ },
+ "dataStoreSettings": { # Data store related settings for the app. # Optional. The data store settings for the app.
+ "engines": [ # Output only. The engines for the app.
+ { # An engine to which the data stores are connected. See Vertex AI Search: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction.
+ "name": "A String", # Output only. The resource name of the engine. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
+ "type": "A String", # Output only. The type of the engine.
+ },
+ ],
+ },
+ "defaultChannelProfile": { # A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony. # Optional. The default channel profile used by the app.
+ "channelType": "A String", # Optional. The type of the channel profile.
+ "disableBargeInControl": True or False, # Optional. Whether to disable user barge-in control in the conversation. - **true**: User interruptions are disabled while the agent is speaking. - **false**: The agent retains automatic control over when the user can interrupt.
+ "disableDtmf": True or False, # Optional. Whether to disable DTMF (dual-tone multi-frequency).
+ "instagramConfig": { # Configuration specific to Instagram deployments. # Optional. Configuration specific to Instagram deployments.
+ "description": "A String", # Output only. The description of the Meta business page or profile.
+ "displayName": "A String", # Output only. The fetched Meta business page name.
+ "instagramAccountId": "A String", # Required. The Instagram Account ID.
+ "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL.
+ },
+ "noiseSuppressionLevel": "A String", # Optional. The noise suppression level of the channel profile. Available values are "low", "moderate", "high", "very_high".
+ "personaProperty": { # Represents the persona property of a channel. # Optional. The persona property of the channel profile.
+ "persona": "A String", # Optional. The persona of the channel.
+ },
+ "profileId": "A String", # Optional. The unique identifier of the channel profile.
+ "webWidgetConfig": { # Message for configuration for the web widget. # Optional. The configuration for the web widget.
+ "modality": "A String", # Optional. The modality of the web widget.
+ "securitySettings": { # Security settings for the web widget. # Optional. The security settings of the web widget.
+ "allowedOrigins": [ # Optional. The origins that are allowed to host the web widget. An origin is defined by RFC 6454. If empty, all origins are allowed. A maximum of 100 origins is allowed. Example: "https://example.com"
+ "A String",
+ ],
+ "enableOriginCheck": True or False, # Optional. Indicates whether origin check for the web widget is enabled. If `true`, the web widget will check the origin of the website that loads the web widget and only allow it to be loaded in the same origin or any of the allowed origins.
+ "enablePublicAccess": True or False, # Optional. Indicates whether public access to the web widget is enabled. If `true`, the web widget will be publicly accessible. If `false`, the web widget must be integrated with your own authentication and authorization system to return valid credentials for accessing the CES agent.
+ "enableRecaptcha": True or False, # Optional. Indicates whether reCAPTCHA verification for the web widget is enabled.
+ },
+ "theme": "A String", # Optional. The theme of the web widget.
+ "webWidgetTitle": "A String", # Optional. The title of the web widget.
+ },
+ "whatsappConfig": { # Configuration specific to WhatsApp deployments. # Optional. Configuration specific to WhatsApp deployments.
+ "description": "A String", # Output only. The description of the Meta business page or profile.
+ "displayName": "A String", # Output only. The fetched Meta business page name.
+ "phoneNumber": "A String", # Optional. The phone number in E.164 format.
+ "phoneNumberId": "A String", # Required. The Meta phone number ID.
+ "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL.
+ "wabaId": "A String", # Required. The WhatsApp Business Account ID.
+ },
+ },
+ "deploymentCount": 42, # Output only. Number of deployments in the app.
+ "description": "A String", # Optional. Human-readable description of the app.
+ "displayName": "A String", # Required. Display name of the app.
+ "errorHandlingSettings": { # Settings to describe how errors should be handled in the app. # Optional. Error handling settings of the app.
+ "endSessionConfig": { # Configuration for ending the session in case of system errors (e.g. LLM errors). # Optional. Configuration for ending the session in case of system errors (e.g. LLM errors).
+ "escalateSession": True or False, # Optional. Whether to escalate the session in EndSession. If session is escalated, metadata in EndSession will contain `session_escalated = true`. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/deploy/google-telephony-platform#transfer_a_call_to_a_human_agent for details.
+ },
+ "errorHandlingStrategy": "A String", # Optional. The strategy to use for error handling.
+ "fallbackResponseConfig": { # Configuration for handling fallback responses. # Optional. Configuration for handling fallback responses.
+ "customFallbackMessages": { # Optional. The fallback messages in case of system errors (e.g. LLM errors), mapped by [supported language code](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/reference/language).
+ "a_key": "A String",
+ },
+ "maxFallbackAttempts": 42, # Optional. The maximum number of fallback attempts to make before the agent emitting EndSession Signal.
+ },
+ },
+ "etag": "A String", # Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
+ "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Optional. The evaluation thresholds for the app.
+ "goldenEvaluationMetricsThresholds": { # Settings for golden evaluations. # Optional. The golden evaluation metrics thresholds.
+ "expectationLevelMetricsThresholds": { # Expectation level metrics thresholds. # Optional. The expectation level metrics thresholds.
+ "toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0.
+ },
+ "toolMatchingSettings": { # Settings for matching tool calls. # Optional. The tool matching settings. An extra tool call is a tool call that is present in the execution but does not match any tool call in the golden expectation.
+ "extraToolCallBehavior": "A String", # Optional. Behavior for extra tool calls. Defaults to FAIL.
+ },
+ "turnLevelMetricsThresholds": { # Turn level metrics thresholds. # Optional. The turn level metrics thresholds.
+ "overallToolInvocationCorrectnessThreshold": 3.14, # Optional. The success threshold for overall tool invocation correctness. Must be a float between 0 and 1. Default is 1.0.
+ "semanticSimilarityChannel": "A String", # Optional. The semantic similarity channel to use for evaluation.
+ "semanticSimilaritySuccessThreshold": 42, # Optional. The success threshold for semantic similarity. Must be an integer between 0 and 4. Default is >= 3.
+ },
+ },
+ "goldenHallucinationMetricBehavior": "A String", # Optional. The hallucination metric behavior for golden evaluations.
+ "hallucinationMetricBehavior": "A String", # Optional. Deprecated: Use `golden_hallucination_metric_behavior` instead. The hallucination metric behavior is currently used for golden evaluations.
+ "scenarioHallucinationMetricBehavior": "A String", # Optional. The hallucination metric behavior for scenario evaluations.
+ },
+ "evaluationPersonas": [ # Optional. The evaluation personas for the app. This field is used to define the personas that can be used for evaluation. Maximum of 30 personas can be defined.
+ { # A persona represents an end user in an evaluation.
+ "description": "A String", # Optional. The description of the persona.
+ "displayName": "A String", # Required. The display name of the persona. Unique within an app.
+ "name": "A String", # Required. The unique identifier of the persona. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationPersonas/{evaluationPersona}`
+ "personality": "A String", # Required. An instruction for the agent on how to behave in the evaluation.
+ "speechConfig": { # Configuration for Text-to-Speech generation. # Optional. Configuration for how the persona sounds (TTS settings).
+ "environment": "A String", # Optional. The simulated audio environment.
+ "speakingRate": 3.14, # Optional. The speaking rate. 1.0 is normal. Lower is slower (e.g., 0.8), higher is faster (e.g., 1.5). Useful for testing how the agent handles fast talkers.
+ "voiceId": "A String", # Optional. The specific voice identifier/accent to use. Example: "en-US-Wavenet-D" or "en-GB-Standard-A"
+ },
+ },
+ ],
+ "evaluationSettings": { # Settings for evaluation. # Optional. The evaluation settings for the app.
+ "evaluationRunCachingSettings": { # Settings for evaluation run caching. # Optional. The caching settings to use for the evaluation run.
+ "runCachingMode": "A String", # Optional. The caching mode to use for the evaluation run. If not set, default to FORCE_RUN.
+ },
+ "goldenEvaluationToolCallBehaviour": "A String", # Optional. Configures the default tool call behaviour for golden evaluations.
+ "goldenRunMethod": "A String", # Optional. The default method used to run golden evaluations. This will be used if no golden_run_method is specified in the RunEvaluationRequest.
+ "metricsConfig": { # Configures the metrics for an evaluation. # Optional. Configures the default metrics for evaluations.
+ "goldenMetricsConfig": { # Configuration for the golden metrics for the evaluation. # Optional. Configuration for the golden metrics for the evaluation.
+ "semanticSimilarityMetricsConfig": { # Configuration for similarity metrics for the evaluation. To disable the metric, set the message but do not set the `enable_semantic_similarity_metrics` field to true (or explicitly set it to false). To unset the configuration and fallback to the default behavior, omit the message entirely. # Optional. Global configuration for semantic similarity metrics.
+ "enableSemanticSimilarityMetrics": True or False, # Optional. Whether to calculate semantic similarity metrics for the evaluation.
+ },
+ "stepToolCorrectnessMetricsConfig": { # Configuration for correctness metrics for the evaluation. To disable the metric, set the message but do not set the `enable_tool_correctness_metrics` field to true (or explicitly set it to false). To unset the configuration and fallback to the default behavior, omit the message entirely. # Optional. Configuration for step level tool correctness metrics.
+ "enableToolCorrectnessMetrics": True or False, # Optional. Whether to calculate tool correctness metrics for the evaluation.
+ },
+ "toolCorrectnessMetricsConfig": { # Configuration for correctness metrics for the evaluation. To disable the metric, set the message but do not set the `enable_tool_correctness_metrics` field to true (or explicitly set it to false). To unset the configuration and fallback to the default behavior, omit the message entirely. # Optional. Configuration for turn level tool correctness metrics.
+ "enableToolCorrectnessMetrics": True or False, # Optional. Whether to calculate tool correctness metrics for the evaluation.
+ },
+ },
+ "scenarioMetricsConfig": { # Configuration for the scenario metrics for the evaluation. # Optional. Configuration for the scenario metrics for the evaluation.
+ "expectationsMetMetricsConfig": { # Configuration for the expectation level metrics for the evaluation. To disable the metric, set the message but do not set the `enable_expectations_met_metrics` field to true (or explicitly set it to false). To unset the configuration and fallback to the default behavior, omit the message entirely. # Optional. Configuration for expectation level metrics.
+ "enableExpectationsMetMetrics": True or False, # Optional. Whether to calculate the expectation level metrics for the evaluation.
+ },
+ "userGoalMetMetricsConfig": { # Configuration for the user goal met metrics for the evaluation. To disable the metric, set the message but do not set the `enable_user_goal_met_metrics` field to true (or explicitly set it to false). To unset the configuration and fallback to the default behavior, omit the message entirely. # Optional. Configuration for user goal met metrics.
+ "enableUserGoalMetMetrics": True or False, # Optional. Whether to calculate the user goal met metrics for the evaluation.
+ },
+ },
+ },
+ "scenarioConversationInitiator": "A String", # Optional. Who starts the conversation in a scenario evaluation.
+ "scenarioEvaluationToolCallBehaviour": "A String", # Optional. Configures the default tool call behaviour for scenario evaluations.
+ "scenarioExecutionMode": "A String", # Optional. The execution mode for scenario evaluations. If not provided, will default to QUALITY_OPTIMIZED.
+ },
+ "globalInstruction": "A String", # Optional. Instructions for all the agents in the app. You can use this instruction to set up a stable identity or personality across all the agents.
+ "guardrails": [ # Optional. List of guardrails for the app. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`
+ "A String",
+ ],
+ "languageSettings": { # Language settings of the app. # Optional. Language settings of the app.
+ "defaultLanguageCode": "A String", # Optional. The default language code of the app.
+ "enableMultilingualSupport": True or False, # Optional. Enables multilingual support. If true, agents in the app will use pre-built instructions to improve handling of multilingual input.
+ "fallbackAction": "A String", # Optional. Deprecated: This feature is no longer supported. Use `enable_multilingual_support` instead to improve handling of multilingual input. The action to perform when an agent receives input in an unsupported language. This can be a predefined action or a custom tool call. Valid values are: - A tool's full resource name, which triggers a specific tool execution. - A predefined system action, such as "escalate" or "exit", which triggers an EndSession signal with corresponding metadata to terminate the conversation.
+ "supportedLanguageCodes": [ # Optional. List of languages codes supported by the app, in addition to the `default_language_code`.
+ "A String",
+ ],
+ },
+ "locked": True or False, # Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected.
+ "loggingSettings": { # Settings to describe the logging behaviors for the app. # Optional. Logging settings of the app.
+ "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. The audio is subject to redaction as configured in RedactionConfig.
+ "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used.
+ },
+ "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The conversation data is subject to redaction as configured in RedactionConfig.
+ "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to.
+ "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled.
+ "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ },
+ "cloudLoggingSettings": { # Settings to describe the Cloud Logging behaviors for the app. # Optional. Settings to describe the Cloud Logging behaviors for the app.
+ "enableCloudLogging": True or False, # Optional. Whether to enable Cloud Logging for the sessions.
+ },
+ "conversationLoggingSettings": { # Settings to describe the conversation logging behaviors for the app. # Optional. Settings to describe the conversation logging behaviors for the app.
+ "disableConversationLogging": True or False, # Optional. Whether to disable conversation logging for the sessions.
+ "retentionWindow": "A String", # Optional. Controls the retention window for the conversation. If not set, the conversation will be retained for 365 days.
+ },
+ "evaluationAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded for the evaluation. By default, audio recording is not enabled for evaluation sessions.
+ "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used.
+ },
+ "metricAnalysisSettings": { # Settings to describe the conversation data collection behaviors for LLM analysis metrics pipeline. # Optional. Settings to describe the conversation data collection behaviors for the LLM analysis pipeline for the app.
+ "llmMetricsOptedOut": True or False, # Optional. Whether to collect conversation data for llm analysis metrics. If true, conversation data will not be collected for llm analysis metrics; otherwise, conversation data will be collected.
+ },
+ "redactionConfig": { # Configuration to instruct how sensitive data should be handled. # Optional. Configuration for how sensitive data should be redacted.
+ "deidentifyTemplate": "A String", # Optional. [DLP](https://cloud.google.com/dlp/docs) deidentify template name to instruct on how to de-identify content. Format: `projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template}`
+ "enableRedaction": True or False, # Optional. If true, redaction will be applied in various logging scenarios, including conversation history, Cloud Logging and audio recording.
+ "inspectTemplate": "A String", # Optional. [DLP](https://cloud.google.com/dlp/docs) inspect template name to configure detection of sensitive data types. Format: `projects/{project}/locations/{location}/inspectTemplates/{inspect_template}`
+ },
+ "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures an additional recording of unredacted audio. This can be used to maintain a raw audio copy when audio redaction is enabled, typically for auditing or monitoring purposes.
+ "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used.
+ },
+ "unredactedBigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The unredacted conversation data will be exported to BigQuery tables if it is enabled.
+ "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to.
+ "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled.
+ "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ },
+ },
+ "metadata": { # Optional. Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages.
+ "a_key": "A String",
+ },
+ "modelSettings": { # Model settings contains various configurations for the LLM model. # Optional. The default LLM model settings for the app. Individual resources (e.g. agents, guardrails) can override these configurations as needed.
+ "model": "A String", # Optional. The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
+ "temperature": 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
+ },
+ "name": "A String", # Identifier. The unique identifier of the app. Format: `projects/{project}/locations/{location}/apps/{app}`
+ "pinned": True or False, # Optional. Whether the app is pinned in the app list.
+ "predefinedVariableDeclarations": [ # Output only. The declarations of predefined variables for the app.
+ { # Defines the structure and metadata for a variable.
+ "description": "A String", # Required. The description of the variable.
+ "name": "A String", # Required. The name of the variable. The name must start with a letter or underscore and contain only letters, numbers, or underscores.
+ "schema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Required. The schema of the variable.
+ "additionalProperties": # Object with schema name: Schema # 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: Schema
+ ],
+ "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: Schema
+ },
+ "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",
+ ],
+ "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
+ "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+ "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
+ "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+ "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
+ "nullable": True or False, # Optional. Indicates if the value may be null.
+ "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY.
+ # Object with schema name: Schema
+ ],
+ "properties": { # Optional. Properties of Type.OBJECT.
+ "a_key": # Object with schema name: Schema
+ },
+ "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", # Required. The type of the data.
+ "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
+ },
+ },
+ ],
+ "rootAgent": "A String", # Optional. The root agent is the entry point of the app. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
+ "timeZoneSettings": { # TimeZone settings of the app. # Optional. TimeZone settings of the app.
+ "timeZone": "A String", # Optional. The time zone of the app from the [time zone database](https://www.iana.org/time-zones), e.g., America/Los_Angeles, Europe/Paris.
+ },
+ "toolExecutionMode": "A String", # Optional. The tool execution mode for the app. If not provided, will default to PARALLEL.
+ "updateTime": "A String", # Output only. Timestamp when the app was last updated.
+ "validationErrors": [ # Output only. Misconfigurations or warnings in the app.
+ "A String",
+ ],
+ "variableDeclarations": [ # Optional. The declarations of the variables.
+ { # Defines the structure and metadata for a variable.
+ "description": "A String", # Required. The description of the variable.
+ "name": "A String", # Required. The name of the variable. The name must start with a letter or underscore and contain only letters, numbers, or underscores.
+ "schema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Required. The schema of the variable.
+ "additionalProperties": # Object with schema name: Schema # 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: Schema
+ ],
+ "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: Schema
+ },
+ "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",
+ ],
+ "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
+ "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+ "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
+ "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+ "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
+ "nullable": True or False, # Optional. Indicates if the value may be null.
+ "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY.
+ # Object with schema name: Schema
+ ],
+ "properties": { # Optional. Properties of Type.OBJECT.
+ "a_key": # Object with schema name: Schema
+ },
+ "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", # Required. The type of the data.
+ "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
+ },
+ },
+ ],
+ "vpcScSettings": { # VPC-SC settings for the app. # Optional. VPC-SC settings for the app.
+ "allowedOrigins": [ # Optional. The allowed HTTP(s) origins that OpenAPI tools in the App are able to directly call when VPC Service Controls are enabled. These strings must match the origin exactly, including the port if specified. For example, "https://example.com" or "https://example.com:443". This list does not yet apply to Python tools that may make direct HTTP calls.
+ "A String",
+ ],
+ },
+ },
+ "examples": [ # Optional. List of examples in the app.
+ { # An example represents a sample conversation between the user and the agent(s).
+ "createTime": "A String", # Output only. Timestamp when the example was created.
+ "description": "A String", # Optional. Human-readable description of the example.
+ "displayName": "A String", # Required. Display name of the example.
+ "entryAgent": "A String", # Optional. The agent that initially handles the conversation. If not specified, the example represents a conversation that is handled by the root agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
+ "etag": "A String", # Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
+ "invalid": True or False, # Output only. The example may become invalid if referencing resources are deleted. Invalid examples will not be used as few-shot examples.
+ "messages": [ # Optional. The collection of messages that make up the conversation.
+ { # A message within a conversation.
+ "chunks": [ # Optional. Content of the message as a series of chunks.
+ { # A chunk of content within a message.
+ "agentTransfer": { # Represents an event indicating the transfer of a conversation to a different agent. # Optional. Agent transfer event.
+ "displayName": "A String", # Output only. Display name of the agent.
+ "targetAgent": "A String", # Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
+ },
+ "blob": { # Represents a blob input or output in the conversation. # Optional. Blob data.
+ "data": "A String", # Required. Raw bytes of the blob.
+ "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+ },
+ "defaultVariables": { # A struct represents default variables at the start of the conversation, keyed by variable names.
+ "a_key": "", # Properties of the object.
+ },
+ "image": { # Represents an image input or output in the conversation. # Optional. Image data.
+ "altText": "A String", # Optional. The alternative text for the image.
+ "data": "A String", # Required. Raw bytes of the image.
+ "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp
+ },
+ "payload": { # Optional. Custom payload data.
+ "a_key": "", # Properties of the object.
+ },
+ "text": "A String", # Optional. Text data.
+ "toolCall": { # Request for the client or the agent to execute the specified tool. # Optional. Tool execution request.
+ "agentName": "A String", # Output only. Human-readable name of the agent that issued this call, e.g. "Contract Architect". Empty when the root agent issued it.
+ "args": { # Optional. The input parameters and values for the tool in JSON object format.
+ "a_key": "", # Properties of the object.
+ },
+ "displayName": "A String", # Output only. Display name of the tool.
+ "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse.
+ "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling.
+ "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
+ "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute.
+ "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for.
+ "toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
+ },
+ },
+ "toolResponse": { # The execution result of a specific tool from the client or the agent. # Optional. Tool execution response.
+ "agentName": "A String", # Output only. Human-readable name of the agent that issued this call, e.g. "Contract Architect". Empty when the root agent issued it.
+ "displayName": "A String", # Output only. Display name of the tool.
+ "id": "A String", # Optional. The matching ID of the tool call the response is for.
+ "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling.
+ "response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result.
+ "a_key": "", # Properties of the object.
+ },
+ "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
+ "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed.
+ "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for.
+ "toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
+ },
+ },
+ "transcript": "A String", # Optional. Transcript associated with the audio.
+ "updatedVariables": { # A struct represents variables that were updated in the conversation, keyed by variable names.
+ "a_key": "", # Properties of the object.
+ },
+ },
+ ],
+ "eventTime": "A String", # Optional. Timestamp when the message was sent or received. Should not be used if the message is part of an example.
+ "role": "A String", # Optional. The role within the conversation, e.g., user, agent.
+ },
+ ],
+ "name": "A String", # Identifier. The unique identifier of the example. Format: `projects/{project}/locations/{location}/apps/{app}/examples/{example}`
+ "updateTime": "A String", # Output only. Timestamp when the example was last updated.
+ },
+ ],
+ "guardrails": [ # Optional. List of guardrails in the app.
+ { # Guardrail contains a list of checks and balances to keep the agents safe and secure.
+ "action": { # Action that is taken when a certain precondition is met. # Optional. Action to take when the guardrail is triggered.
+ "generativeAnswer": { # The agent will immediately respond with a generative answer. # Optional. Respond with a generative answer.
+ "prompt": "A String", # Required. The prompt to use for the generative answer.
+ },
+ "respondImmediately": { # The agent will immediately respond with a preconfigured response. # Optional. Immediately respond with a preconfigured response.
+ "responses": [ # Required. The canned responses for the agent to choose from. The response is chosen randomly.
+ { # Represents a response from the agent.
+ "disabled": True or False, # Optional. Whether the response is disabled. Disabled responses are not used by the agent.
+ "text": "A String", # Required. Text for the agent to respond with.
+ },
+ ],
+ },
+ "transferAgent": { # The agent will transfer the conversation to a different agent. # Optional. Transfer the conversation to a different agent.
+ "agent": "A String", # Required. The name of the agent to transfer the conversation to. The agent must be in the same app as the current agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
+ },
+ },
+ "codeCallback": { # Guardrail that blocks the conversation based on the code callbacks provided. # Optional. Guardrail that potentially blocks the conversation based on the result of the callback execution.
+ "afterAgentCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute after the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
+ "description": "A String", # Optional. Human-readable description of the callback.
+ "disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
+ "pythonCode": "A String", # Required. The python code to execute for the callback.
+ },
+ "afterModelCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute after the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
+ "description": "A String", # Optional. Human-readable description of the callback.
+ "disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
+ "pythonCode": "A String", # Required. The python code to execute for the callback.
+ },
+ "beforeAgentCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute before the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
+ "description": "A String", # Optional. Human-readable description of the callback.
+ "disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
+ "pythonCode": "A String", # Required. The python code to execute for the callback.
+ },
+ "beforeModelCallback": { # A callback defines the custom logic to be executed at various stages of agent interaction. # Optional. The callback to execute before the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing.
+ "description": "A String", # Optional. Human-readable description of the callback.
+ "disabled": True or False, # Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent.
+ "proactiveExecutionEnabled": True or False, # Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations.
+ "pythonCode": "A String", # Required. The python code to execute for the callback.
+ },
+ },
+ "contentFilter": { # Guardrail that bans certain content from being used in the conversation. # Optional. Guardrail that bans certain content from being used in the conversation.
+ "bannedContents": [ # Optional. List of banned phrases. Applies to both user inputs and agent responses.
+ "A String",
+ ],
+ "bannedContentsInAgentResponse": [ # Optional. List of banned phrases. Applies only to agent responses.
+ "A String",
+ ],
+ "bannedContentsInUserInput": [ # Optional. List of banned phrases. Applies only to user inputs.
+ "A String",
+ ],
+ "disregardDiacritics": True or False, # Optional. If true, diacritics are ignored during matching.
+ "matchType": "A String", # Required. Match type for the content filter.
+ },
+ "createTime": "A String", # Output only. Timestamp when the guardrail was created.
+ "description": "A String", # Optional. Description of the guardrail.
+ "displayName": "A String", # Required. Display name of the guardrail.
+ "enabled": True or False, # Optional. Whether the guardrail is enabled.
+ "etag": "A String", # Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
+ "llmPolicy": { # Guardrail that blocks the conversation if the LLM response is considered violating the policy based on the LLM classification. # Optional. Guardrail that blocks the conversation if the LLM response is considered violating the policy based on the LLM classification.
+ "allowShortUtterance": True or False, # Optional. By default, the LLM policy check is bypassed for short utterances. Enabling this setting applies the policy check to all utterances, including those that would normally be skipped.
+ "failOpen": True or False, # Optional. If an error occurs during the policy check, fail open and do not trigger the guardrail.
+ "maxConversationMessages": 42, # Optional. When checking this policy, consider the last 'n' messages in the conversation. When not set a default value of 10 will be used.
+ "modelSettings": { # Model settings contains various configurations for the LLM model. # Optional. Model settings.
+ "model": "A String", # Optional. The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
+ "temperature": 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
+ },
+ "policyScope": "A String", # Required. Defines when to apply the policy check during the conversation. If set to `POLICY_SCOPE_UNSPECIFIED`, the policy will be applied to the user input. When applying the policy to the agent response, additional latency will be introduced before the agent can respond.
+ "prompt": "A String", # Required. Policy prompt.
+ },
+ "llmPromptSecurity": { # Guardrail that blocks the conversation if the input is considered unsafe based on the LLM classification. # Optional. Guardrail that blocks the conversation if the prompt is considered unsafe based on the LLM classification.
+ "customPolicy": { # Guardrail that blocks the conversation if the LLM response is considered violating the policy based on the LLM classification. # Optional. Use a user-defined LlmPolicy to configure the security guardrail.
+ "allowShortUtterance": True or False, # Optional. By default, the LLM policy check is bypassed for short utterances. Enabling this setting applies the policy check to all utterances, including those that would normally be skipped.
+ "failOpen": True or False, # Optional. If an error occurs during the policy check, fail open and do not trigger the guardrail.
+ "maxConversationMessages": 42, # Optional. When checking this policy, consider the last 'n' messages in the conversation. When not set a default value of 10 will be used.
+ "modelSettings": { # Model settings contains various configurations for the LLM model. # Optional. Model settings.
+ "model": "A String", # Optional. The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
+ "temperature": 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
+ },
+ "policyScope": "A String", # Required. Defines when to apply the policy check during the conversation. If set to `POLICY_SCOPE_UNSPECIFIED`, the policy will be applied to the user input. When applying the policy to the agent response, additional latency will be introduced before the agent can respond.
+ "prompt": "A String", # Required. Policy prompt.
+ },
+ "defaultSettings": { # Configuration for default system security settings. # Optional. Use the system's predefined default security settings. To select this mode, include an empty 'default_settings' message in the request. The 'default_prompt_template' field within will be populated by the server in the response.
+ "defaultPromptTemplate": "A String", # Output only. The default prompt template used by the system. This field is for display purposes to show the user what prompt the system uses by default. It is OUTPUT_ONLY.
+ },
+ "failOpen": True or False, # Optional. Determines the behavior when the guardrail encounters an LLM error. - If true: the guardrail is bypassed. - If false (default): the guardrail triggers/blocks. Note: If a custom policy is provided, this field is ignored in favor of the policy's 'fail_open' configuration.
+ },
+ "modelSafety": { # Model safety settings overrides. When this is set, it will override the default settings and trigger the guardrail if the response is considered unsafe. # Optional. Guardrail that blocks the conversation if the LLM response is considered unsafe based on the model safety settings.
+ "safetySettings": [ # Required. List of safety settings.
+ { # Safety setting.
+ "category": "A String", # Required. The harm category.
+ "threshold": "A String", # Required. The harm block threshold.
+ },
+ ],
+ },
+ "name": "A String", # Identifier. The unique identifier of the guardrail. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`
+ "updateTime": "A String", # Output only. Timestamp when the guardrail was last updated.
+ },
+ ],
+ "tools": [ # Optional. List of tools in the app.
+ { # A tool represents an action that the CES agent can take to achieve certain goals.
+ "agentTool": { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool.
+ "agent": "A String", # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}`
+ "description": "A String", # Optional. Description of the tool's purpose.
+ "name": "A String", # Required. The name of the agent tool.
+ },
+ "clientFunction": { # Represents a client-side function that the agent can invoke. When the tool is chosen by the agent, control is handed off to the client. The client is responsible for executing the function and returning the result as a ToolResponse to continue the interaction with the agent. # Optional. The client function.
+ "description": "A String", # Optional. The function description.
+ "name": "A String", # Required. The function name.
+ "parameters": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the function parameters.
+ "additionalProperties": # Object with schema name: Schema # 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: Schema
+ ],
+ "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: Schema
+ },
+ "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",
+ ],
+ "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
+ "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+ "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
+ "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+ "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
+ "nullable": True or False, # Optional. Indicates if the value may be null.
+ "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY.
+ # Object with schema name: Schema
+ ],
+ "properties": { # Optional. Properties of Type.OBJECT.
+ "a_key": # Object with schema name: Schema
+ },
+ "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", # Required. The type of the data.
+ "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
+ },
+ "response": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the function response.
+ "additionalProperties": # Object with schema name: Schema # 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: Schema
+ ],
+ "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: Schema
+ },
+ "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",
+ ],
+ "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
+ "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+ "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
+ "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+ "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
+ "nullable": True or False, # Optional. Indicates if the value may be null.
+ "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY.
+ # Object with schema name: Schema
+ ],
+ "properties": { # Optional. Properties of Type.OBJECT.
+ "a_key": # Object with schema name: Schema
+ },
+ "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", # Required. The type of the data.
+ "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
+ },
+ },
+ "connectorTool": { # A ConnectorTool allows connections to different integrations. See: https://cloud.google.com/integration-connectors/docs/overview. # Optional. The Integration Connector tool.
+ "action": { # Configuration of an Action for the tool to use. Note: This can be either an Action or an Operation. See https://cloud.google.com/integration-connectors/docs/entities-operation-action for details. # Required. Action for the tool to use.
+ "connectionActionId": "A String", # ID of a Connection action for the tool to use.
+ "entityOperation": { # Entity CRUD operation specification. # Entity operation configuration for the tool to use.
+ "entityId": "A String", # Required. ID of the entity.
+ "operation": "A String", # Required. Operation to perform on the entity.
+ },
+ "inputFields": [ # Optional. Entity fields to use as inputs for the operation. If no fields are specified, all fields of the Entity will be used.
+ "A String",
+ ],
+ "outputFields": [ # Optional. Entity fields to return from the operation. If no fields are specified, all fields of the Entity will be returned.
+ "A String",
+ ],
+ },
+ "authConfig": { # End-user authentication configuration used for Connection calls. The field values must be the names of context variables in the format `$context.variables.`. # Optional. Configures how authentication is handled in Integration Connectors. By default, an admin authentication is passed in the Integration Connectors API requests. You can override it with a different end-user authentication config. **Note**: The Connection must have authentication override enabled in order to specify an EUC configuration here - otherwise, the ConnectorTool creation will fail. See https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override for details.
+ "oauth2AuthCodeConfig": { # Oauth 2.0 Authorization Code authentication configuration. # Oauth 2.0 Authorization Code authentication.
+ "oauthToken": "A String", # Required. Oauth token parameter name to pass through. Must be in the format `$context.variables.`.
+ },
+ "oauth2JwtBearerConfig": { # JWT Profile Oauth 2.0 Authorization Grant authentication configuration. # JWT Profile Oauth 2.0 Authorization Grant authentication.
+ "clientKey": "A String", # Required. Client parameter name to pass through. Must be in the format `$context.variables.`.
+ "issuer": "A String", # Required. Issuer parameter name to pass through. Must be in the format `$context.variables.`.
+ "subject": "A String", # Required. Subject parameter name to pass through. Must be in the format `$context.variables.`.
+ },
+ },
+ "connection": "A String", # Required. The full resource name of the referenced Integration Connectors Connection. Format: `projects/{project}/locations/{location}/connections/{connection}`
+ "description": "A String", # Optional. The description of the tool that can be used by the Agent to decide whether to call this ConnectorTool.
+ "name": "A String", # Optional. The name of the tool that can be used by the Agent to decide whether to call this ConnectorTool.
+ },
+ "createTime": "A String", # Output only. Timestamp when the tool was created.
+ "dataStoreTool": { # Tool to retrieve from Vertex AI Search datastore or engine for grounding. Accepts either a datastore or an engine, but not both. See Vertex AI Search: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction. # Optional. The data store tool.
+ "boostSpecs": [ # Optional. Boost specification to boost certain documents.
+ { # Boost specifications to boost certain documents. For more information, please refer to https://cloud.google.com/generative-ai-app-builder/docs/boosting.
+ "dataStores": [ # Required. The Data Store where the boosting configuration is applied. Full resource name of DataStore, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}.
+ "A String",
+ ],
+ "spec": [ # Required. A list of boosting specifications.
+ { # Boost specification to boost certain documents.
+ "conditionBoostSpecs": [ # Required. A list of boosting specifications.
+ { # Boost specification for a condition.
+ "boost": 3.14, # Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the suggestions a big promotion. However, it does not necessarily mean that the top result will be a boosted suggestion. Setting to -1.0 gives the suggestions a big demotion. However, other suggestions that are relevant might still be shown. Setting to 0.0 means no boost applied. The boosting condition is ignored.
+ "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Optional. Complex specification for custom ranking based on customer defined attribute value.
+ "attributeType": "A String", # Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).
+ "controlPoints": [ # Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.
+ { # The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).
+ "attributeValue": "A String", # Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.
+ "boostAmount": 3.14, # Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
+ },
+ ],
+ "fieldName": "A String", # Optional. The name of the field whose value will be used to determine the boost amount.
+ "interpolationType": "A String", # Optional. The interpolation type to be applied to connect the control points listed below.
+ },
+ "condition": "A String", # Required. An expression which specifies a boost condition. The syntax is the same as filter expression syntax. Currently, the only supported condition is a list of BCP-47 lang codes. Example: To boost suggestions in languages en or fr: (lang_code: ANY("en", "fr"))
+ },
+ ],
+ },
+ ],
+ },
+ ],
+ "dataStoreSource": { # Configuration for searching within a specific DataStore. # Optional. Search within a single specific DataStore.
+ "dataStore": { # A DataStore resource in Vertex AI Search. # Optional. The data store.
+ "connectorConfig": { # The connector config for the data store connection. # Output only. The connector config for the data store connection.
+ "collection": "A String", # Resource name of the collection the data store belongs to.
+ "collectionDisplayName": "A String", # Display name of the collection the data store belongs to.
+ "dataSource": "A String", # The name of the data source. Example: `salesforce`, `jira`, `confluence`, `bigquery`.
+ },
+ "createTime": "A String", # Output only. Timestamp when the data store was created.
+ "displayName": "A String", # Output only. The display name of the data store.
+ "documentProcessingMode": "A String", # Output only. The document processing mode for the data store connection. Only set for PUBLIC_WEB and UNSTRUCTURED data stores.
+ "name": "A String", # Required. Full resource name of the DataStore. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
+ "type": "A String", # Output only. The type of the data store. This field is readonly and populated by the server.
+ },
+ "filter": "A String", # Optional. Filter specification for the DataStore. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
+ },
+ "description": "A String", # Optional. The tool description.
+ "engineSource": { # Configuration for searching within an Engine, potentially targeting specific DataStores. # Optional. Search within an Engine (potentially across multiple DataStores).
+ "dataStoreSources": [ # Optional. Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine.
+ { # Configuration for searching within a specific DataStore.
+ "dataStore": { # A DataStore resource in Vertex AI Search. # Optional. The data store.
+ "connectorConfig": { # The connector config for the data store connection. # Output only. The connector config for the data store connection.
+ "collection": "A String", # Resource name of the collection the data store belongs to.
+ "collectionDisplayName": "A String", # Display name of the collection the data store belongs to.
+ "dataSource": "A String", # The name of the data source. Example: `salesforce`, `jira`, `confluence`, `bigquery`.
+ },
+ "createTime": "A String", # Output only. Timestamp when the data store was created.
+ "displayName": "A String", # Output only. The display name of the data store.
+ "documentProcessingMode": "A String", # Output only. The document processing mode for the data store connection. Only set for PUBLIC_WEB and UNSTRUCTURED data stores.
+ "name": "A String", # Required. Full resource name of the DataStore. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
+ "type": "A String", # Output only. The type of the data store. This field is readonly and populated by the server.
+ },
+ "filter": "A String", # Optional. Filter specification for the DataStore. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
+ },
+ ],
+ "engine": "A String", # Required. Full resource name of the Engine. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
+ "filter": "A String", # Optional. A filter applied to the search across the Engine. Not relevant and not used if 'data_store_sources' is provided. See: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
+ },
+ "filterParameterBehavior": "A String", # Optional. The filter parameter behavior.
+ "modalityConfigs": [ # Optional. The modality configs for the data store.
+ { # If specified, will apply the given configuration for the specified modality.
+ "groundingConfig": { # Grounding configuration. # Optional. The grounding configuration.
+ "disabled": True or False, # Optional. Whether grounding is disabled.
+ "groundingLevel": 3.14, # Optional. The groundedness threshold of the answer based on the retrieved sources. The value has a configurable range of [1, 5]. The level is used to threshold the groundedness of the answer, meaning that all responses with a groundedness score below the threshold will fall back to returning relevant snippets only. For example, a level of 3 means that the groundedness score must be 3 or higher for the response to be returned.
+ },
+ "modalityType": "A String", # Required. The modality type.
+ "rewriterConfig": { # Rewriter configuration. # Optional. The rewriter config.
+ "disabled": True or False, # Optional. Whether the rewriter is disabled.
+ "modelSettings": { # Model settings contains various configurations for the LLM model. # Required. Configurations for the LLM model.
+ "model": "A String", # Optional. The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
+ "temperature": 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
+ },
+ "prompt": "A String", # Optional. The prompt definition. If not set, default prompt will be used.
+ },
+ "snippetsConfig": { # Snippets configuration. # Optional. The snippets configuration.
+ "enableSnippets": True or False, # Optional. Whether snippets are enabled.
+ "maxSnippets": 42, # Optional. Number of snippets to return per query. If unset, returns all snippets from the service by default.
+ },
+ "summarizationConfig": { # Summarization configuration. # Optional. The summarization config.
+ "disabled": True or False, # Optional. Whether summarization is disabled.
+ "modelSettings": { # Model settings contains various configurations for the LLM model. # Optional. Configurations for the LLM model.
+ "model": "A String", # Optional. The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent.
+ "temperature": 3.14, # Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative.
+ },
+ "prompt": "A String", # Optional. The prompt definition. If not set, default prompt will be used.
+ },
+ },
+ ],
+ "name": "A String", # Required. The data store tool name.
+ },
+ "displayName": "A String", # Output only. The display name of the tool, derived based on the tool's type. For example, display name of a ClientFunction is derived from its `name` property.
+ "etag": "A String", # Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
+ "executionType": "A String", # Optional. The execution type of the tool.
+ "fileSearchTool": { # The file search tool allows the agent to search across the files uploaded by the app/agent developer. It has presets to give relatively good quality search over the uploaded files and summarization of the retrieved results. # Optional. The file search tool.
+ "corpusType": "A String", # Optional. The type of the corpus. Default is FULLY_MANAGED.
+ "description": "A String", # Optional. The tool description.
+ "fileCorpus": "A String", # Optional. The corpus where files are stored. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}
+ "name": "A String", # Required. The tool name.
+ },
+ "generatedSummary": "A String", # Output only. If the tool is generated by the LLM assistant, this field contains a descriptive summary of the generation.
+ "googleSearchTool": { # Represents a tool to perform Google web searches for grounding. See https://cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool#google-search. # Optional. The google search tool.
+ "contextUrls": [ # Optional. Content will be fetched directly from these URLs for context and grounding. Example: "https://example.com/path.html". A maximum of 20 URLs are allowed.
+ "A String",
+ ],
+ "description": "A String", # Optional. Description of the tool's purpose.
+ "excludeDomains": [ # Optional. List of domains to be excluded from the search results. Example: "example.com". A maximum of 2000 domains can be excluded.
+ "A String",
+ ],
+ "name": "A String", # Required. The name of the tool.
+ "preferredDomains": [ # Optional. Specifies domains to restrict search results to. Example: "example.com", "another.site". A maximum of 20 domains can be specified.
+ "A String",
+ ],
+ "promptConfig": { # Prompt settings used by the model when processing or summarizing the google search results. # Optional. Prompt instructions passed to planner on how the search results should be processed for text and voice.
+ "textPrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in chat conversations. If not set, default prompt will be used.
+ "voicePrompt": "A String", # Optional. Defines the prompt used for the system instructions when interacting with the agent in voice conversations. If not set, default prompt will be used.
+ },
+ },
+ "mcpTool": { # An MCP tool. See https://modelcontextprotocol.io/specification/2025-06-18/server/tools for more details. # Optional. The MCP tool. An MCP tool cannot be created or updated directly and is managed by the MCP toolset.
+ "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required to execute the tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication.
+ "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth.
+ "apiKeySecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
+ "requestLocation": "A String", # Required. Key location in the request.
+ },
+ "bearerTokenConfig": { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth.
+ "token": "A String", # Required. The bearer token. Must be in the format `$context.variables.`.
+ },
+ "oauthConfig": { # Configurations for authentication with OAuth. # Optional. Config for OAuth.
+ "clientId": "A String", # Required. The client ID from the OAuth provider.
+ "clientSecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "oauthGrantType": "A String", # Required. OAuth grant types.
+ "scopes": [ # Optional. The OAuth scopes to grant.
+ "A String",
+ ],
+ "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
+ },
+ "serviceAccountAuthConfig": { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication.
+ "scopes": [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.
+ "A String",
+ ],
+ "serviceAccount": "A String", # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ },
+ "serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent.
+ },
+ },
+ "customHeaders": { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details.
+ "a_key": "A String",
+ },
+ "description": "A String", # Optional. The description of the MCP tool.
+ "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the input arguments of the MCP tool.
+ "additionalProperties": # Object with schema name: Schema # 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: Schema
+ ],
+ "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: Schema
+ },
+ "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",
+ ],
+ "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
+ "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+ "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
+ "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+ "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
+ "nullable": True or False, # Optional. Indicates if the value may be null.
+ "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY.
+ # Object with schema name: Schema
+ ],
+ "properties": { # Optional. Properties of Type.OBJECT.
+ "a_key": # Object with schema name: Schema
+ },
+ "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", # Required. The type of the data.
+ "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
+ },
+ "name": "A String", # Required. The name of the MCP tool.
+ "nameOverride": "A String", # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override.
+ "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool.
+ "additionalProperties": # Object with schema name: Schema # 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: Schema
+ ],
+ "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: Schema
+ },
+ "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",
+ ],
+ "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
+ "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+ "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
+ "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+ "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
+ "nullable": True or False, # Optional. Indicates if the value may be null.
+ "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY.
+ # Object with schema name: Schema
+ ],
+ "properties": { # Optional. Properties of Type.OBJECT.
+ "a_key": # Object with schema name: Schema
+ },
+ "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", # Required. The type of the data.
+ "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
+ },
+ "serverAddress": "A String", # Required. The server address of the MCP server, e.g., "https://example.com/mcp/". If the server is built with the MCP SDK, the url should be suffixed with "/mcp/". Only Streamable HTTP transport based servers are supported. This is the same as the server_address in the McpToolset. See https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http for more details.
+ "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter.
+ "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.
+ },
+ "state": "A String", # Output only. The dynamic availability state of the tool on the external server.
+ "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust.
+ "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
+ { # The CA certificate.
+ "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ```
+ "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
+ },
+ ],
+ },
+ },
+ "name": "A String", # Identifier. The resource name of the tool. Format: * `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for standalone tools. * `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only; they cannot be referenced directly where a tool is expected.
+ "openApiTool": { # A remote API tool defined by an OpenAPI schema. # Optional. The open API tool.
+ "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required by the API.
+ "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth.
+ "apiKeySecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
+ "requestLocation": "A String", # Required. Key location in the request.
+ },
+ "bearerTokenConfig": { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth.
+ "token": "A String", # Required. The bearer token. Must be in the format `$context.variables.`.
+ },
+ "oauthConfig": { # Configurations for authentication with OAuth. # Optional. Config for OAuth.
+ "clientId": "A String", # Required. The client ID from the OAuth provider.
+ "clientSecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "oauthGrantType": "A String", # Required. OAuth grant types.
+ "scopes": [ # Optional. The OAuth scopes to grant.
+ "A String",
+ ],
+ "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
+ },
+ "serviceAccountAuthConfig": { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication.
+ "scopes": [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.
+ "A String",
+ ],
+ "serviceAccount": "A String", # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ },
+ "serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent.
+ },
+ },
+ "description": "A String", # Optional. The description of the tool. If not provided, the description of the tool will be derived from the OpenAPI schema, from `operation.description` or `operation.summary`.
+ "ignoreUnknownFields": True or False, # Optional. If true, the agent will ignore unknown fields in the API response.
+ "name": "A String", # Optional. The name of the tool. If not provided, the name of the tool will be derived from the OpenAPI schema, from `operation.operationId`.
+ "openApiSchema": "A String", # Required. The OpenAPI schema in JSON or YAML format.
+ "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration.
+ "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.
+ },
+ "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client will trust.
+ "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
+ { # The CA certificate.
+ "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ```
+ "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
+ },
+ ],
+ },
+ "url": "A String", # Optional. The server URL of the Open API schema. This field is only set in tools in the environment dependencies during the export process if the schema contains a server url. During the import process, if this url is present in the environment dependencies and the schema has the $env_var placeholder, it will replace the placeholder in the schema.
+ },
+ "pythonFunction": { # A Python function tool. # Optional. The python function tool.
+ "description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring.
+ "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used.
+ "pythonCode": "A String", # Optional. The Python code to execute for the tool.
+ "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool.
+ "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.
+ },
+ },
+ "remoteAgentTool": { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool.
+ "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes.
+ "description": "A String", # Required. A description of the agent's domain of action/solution space.
+ "name": "A String", # Required. A human-readable name for the agent.
+ "skills": [ # Required. Skills represent a unit of ability an agent can perform. This may somewhat abstract but represents a more focused set of actions that the agent is highly likely to succeed at.
+ { # Represents a distinct capability or function that an agent can perform.
+ "description": "A String", # Required. A detailed description of the skill.
+ "examples": [ # Example prompts or scenarios that this skill can handle.
+ "A String",
+ ],
+ "id": "A String", # Required. A unique identifier for the agent's skill.
+ "inputModes": [ # The set of supported input media types for this skill, overriding the agent's defaults.
+ "A String",
+ ],
+ "name": "A String", # Required. A human-readable name for the skill.
+ "outputModes": [ # The set of supported output media types for this skill, overriding the agent's defaults.
+ "A String",
+ ],
+ "tags": [ # Required. A set of keywords describing the skill's capabilities.
+ "A String",
+ ],
+ },
+ ],
+ "supportedInterfaces": [ # Required. Ordered list of supported interfaces. The first entry is preferred.
+ { # Declares a combination of a target URL, transport and protocol version for interacting with the agent. This allows agents to expose the same functionality over multiple protocol binding mechanisms.
+ "protocolBinding": "A String", # Required. The protocol binding supported at this URL. This is an open form string, to be easily extended for other protocol bindings. The core ones officially supported are `JSONRPC`, `GRPC` and `HTTP+JSON`.
+ "protocolVersion": "A String", # Required. The version of the A2A protocol this interface exposes. Use the latest supported minor version per major version. Examples: "0.3", "1.0"
+ "tenant": "A String", # Tenant ID to be used in the request when calling the agent.
+ "url": "A String", # Required. The URL where this interface is available. Must be a valid absolute HTTPS URL in production. Example: "https://api.example.com/a2a/v1", "https://grpc.example.com/a2a"
+ },
+ ],
+ "version": "A String", # Required. The version of the agent.
+ },
+ "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication configuration for calling the remote agent.
+ "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth.
+ "apiKeySecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
+ "requestLocation": "A String", # Required. Key location in the request.
+ },
+ "bearerTokenConfig": { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth.
+ "token": "A String", # Required. The bearer token. Must be in the format `$context.variables.`.
+ },
+ "oauthConfig": { # Configurations for authentication with OAuth. # Optional. Config for OAuth.
+ "clientId": "A String", # Required. The client ID from the OAuth provider.
+ "clientSecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "oauthGrantType": "A String", # Required. OAuth grant types.
+ "scopes": [ # Optional. The OAuth scopes to grant.
+ "A String",
+ ],
+ "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
+ },
+ "serviceAccountAuthConfig": { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication.
+ "scopes": [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.
+ "A String",
+ ],
+ "serviceAccount": "A String", # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ },
+ "serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent.
+ },
+ },
+ "description": "A String", # Required. The description of the tool.
+ "name": "A String", # Required. The name of the tool.
+ },
+ "systemTool": { # Pre-defined system tool. # Optional. The system tool.
+ "description": "A String", # Output only. The description of the system tool.
+ "name": "A String", # Required. The name of the system tool.
+ },
+ "timeout": "A String", # Optional. The timeout for the tool execution. If not set, the default timeout is 30 seconds for `SYNCHRONOUS` tools and 60 seconds for `ASYNCHRONOUS` tools.
+ "toolFakeConfig": { # Configuration for tool behavior in fake mode. # Optional. Configuration for tool behavior in fake mode.
+ "codeBlock": { # A code block to be executed instead of a real tool call. # Optional. Code block which will be executed instead of a real tool call.
+ "pythonCode": "A String", # Required. Python code which will be invoked in tool fake mode. Expected Python function signature - To catch all tool calls: def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: To catch a specific tool call: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: If the function returns None, the real tool will be invoked instead.
+ },
+ "enableFakeMode": True or False, # Optional. Whether the tool is using fake mode.
+ },
+ "updateTime": "A String", # Output only. Timestamp when the tool was last updated.
+ "widgetTool": { # Represents a widget tool that the agent can invoke. When the tool is chosen by the agent, agent will return the widget to the client. The client is responsible for processing the widget and generating the next user query to continue the interaction with the agent. # Optional. The widget tool.
+ "dataMapping": { # Configuration for mapping data from a source tool to the widget's input parameters. # Optional. The mapping that defines how data from a source tool is mapped to the widget's input parameters.
+ "fieldMappings": { # Optional. A map of widget input parameter fields to the corresponding output fields of the source tool.
+ "a_key": "A String",
+ },
+ "mode": "A String", # Optional. The mode of the data mapping.
+ "pythonFunction": { # A Python function tool. # Optional. Configuration for a Python function used to transform the source tool's output into the widget's input format.
+ "description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring.
+ "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used.
+ "pythonCode": "A String", # Optional. The Python code to execute for the tool.
+ "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool.
+ "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.
+ },
+ },
+ "pythonScript": "A String", # Deprecated: Use `python_function` instead.
+ "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}`
+ },
+ "description": "A String", # Optional. The description of the widget tool.
+ "name": "A String", # Required. The display name of the widget tool.
+ "parameters": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The input parameters of the widget tool.
+ "additionalProperties": # Object with schema name: Schema # 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: Schema
+ ],
+ "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: Schema
+ },
+ "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",
+ ],
+ "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
+ "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+ "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
+ "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+ "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
+ "nullable": True or False, # Optional. Indicates if the value may be null.
+ "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY.
+ # Object with schema name: Schema
+ ],
+ "properties": { # Optional. Properties of Type.OBJECT.
+ "a_key": # Object with schema name: Schema
+ },
+ "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", # Required. The type of the data.
+ "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
+ },
+ "textResponseConfig": { # Configuration for the text response returned with the widget. # Optional. Configuration for always-included text responses.
+ "staticText": "A String", # Optional. The static text response to return when type is STATIC.
+ "textResponseInstruction": "A String", # Optional. Instruction for the LLM on how to generate the text response. Used as the description for the text response parameter if type is LLM_GENERATED.
+ "type": "A String", # Optional. The strategy for providing the text response.
+ },
+ "uiConfig": { # Optional. Configuration for rendering the widget.
+ "a_key": "", # Properties of the object.
+ },
+ "widgetType": "A String", # Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED.
+ },
+ },
+ ],
+ "toolsets": [ # Optional. List of toolsets in the app.
+ { # A toolset represents a group of dynamically managed tools that can be used by the agent.
+ "connectorToolset": { # A toolset that generates tools from an Integration Connectors Connection. # Optional. A toolset that generates tools from an Integration Connectors Connection.
+ "authConfig": { # End-user authentication configuration used for Connection calls. The field values must be the names of context variables in the format `$context.variables.`. # Optional. Configures how authentication is handled in Integration Connectors. By default, an admin authentication is passed in the Integration Connectors API requests. You can override it with a different end-user authentication config. **Note**: The Connection must have authentication override enabled in order to specify an EUC configuration here - otherwise, the Toolset creation will fail. See: https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override
+ "oauth2AuthCodeConfig": { # Oauth 2.0 Authorization Code authentication configuration. # Oauth 2.0 Authorization Code authentication.
+ "oauthToken": "A String", # Required. Oauth token parameter name to pass through. Must be in the format `$context.variables.`.
+ },
+ "oauth2JwtBearerConfig": { # JWT Profile Oauth 2.0 Authorization Grant authentication configuration. # JWT Profile Oauth 2.0 Authorization Grant authentication.
+ "clientKey": "A String", # Required. Client parameter name to pass through. Must be in the format `$context.variables.`.
+ "issuer": "A String", # Required. Issuer parameter name to pass through. Must be in the format `$context.variables.`.
+ "subject": "A String", # Required. Subject parameter name to pass through. Must be in the format `$context.variables.`.
+ },
+ },
+ "connection": "A String", # Required. The full resource name of the referenced Integration Connectors Connection. Format: `projects/{project}/locations/{location}/connections/{connection}`
+ "connectorActions": [ # Required. The list of connector actions/entity operations to generate tools for.
+ { # Configuration of an Action for the tool to use. Note: This can be either an Action or an Operation. See https://cloud.google.com/integration-connectors/docs/entities-operation-action for details.
+ "connectionActionId": "A String", # ID of a Connection action for the tool to use.
+ "entityOperation": { # Entity CRUD operation specification. # Entity operation configuration for the tool to use.
+ "entityId": "A String", # Required. ID of the entity.
+ "operation": "A String", # Required. Operation to perform on the entity.
+ },
+ "inputFields": [ # Optional. Entity fields to use as inputs for the operation. If no fields are specified, all fields of the Entity will be used.
+ "A String",
+ ],
+ "outputFields": [ # Optional. Entity fields to return from the operation. If no fields are specified, all fields of the Entity will be returned.
+ "A String",
+ ],
+ },
+ ],
+ },
+ "createTime": "A String", # Output only. Timestamp when the toolset was created.
+ "description": "A String", # Optional. The description of the toolset.
+ "displayName": "A String", # Optional. The display name of the toolset. Must be unique within the same app.
+ "etag": "A String", # ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.
+ "executionType": "A String", # Optional. The execution type of the tools in the toolset.
+ "mcpToolset": { # A toolset that contains a list of tools that are offered by the MCP server. # Optional. A toolset that contains a list of tools that are offered by the MCP server.
+ "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required to access tools and execute a tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication.
+ "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth.
+ "apiKeySecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
+ "requestLocation": "A String", # Required. Key location in the request.
+ },
+ "bearerTokenConfig": { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth.
+ "token": "A String", # Required. The bearer token. Must be in the format `$context.variables.`.
+ },
+ "oauthConfig": { # Configurations for authentication with OAuth. # Optional. Config for OAuth.
+ "clientId": "A String", # Required. The client ID from the OAuth provider.
+ "clientSecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "oauthGrantType": "A String", # Required. OAuth grant types.
+ "scopes": [ # Optional. The OAuth scopes to grant.
+ "A String",
+ ],
+ "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
+ },
+ "serviceAccountAuthConfig": { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication.
+ "scopes": [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.
+ "A String",
+ ],
+ "serviceAccount": "A String", # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ },
+ "serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent.
+ },
+ },
+ "customHeaders": { # Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.` and can be set in the session variables. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection for more details.
+ "a_key": "A String",
+ },
+ "serverAddress": "A String", # Required. The address of the MCP server, for example, "https://example.com/mcp/". If the server is built with the MCP SDK, the url should be suffixed with "/mcp/". Only Streamable HTTP transport based servers are supported. See https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http for more details.
+ "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter.
+ "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.
+ },
+ "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust.
+ "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
+ { # The CA certificate.
+ "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ```
+ "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
+ },
+ ],
+ },
+ "toolOverrides": [ # Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic.
+ { # Overrides associated with a given tool in a Toolset. This enables "pinning" or "overriding" of tool definitions from the external dynamic server.
+ "descriptionOverride": "A String", # Optional. If present, this tool uses this description instead of the original description from the server.
+ "nameOverride": "A String", # Optional. If present, this tool uses this name in the Agent instead of the original name. This is primarily used as an alias if the MCP server offers poorly named tools.
+ "snapshot": { # Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden. # Output only. If present, this tool is "Pinned" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present.
+ "description": "A String", # Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`.
+ "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the input arguments of the MCP tool.
+ "additionalProperties": # Object with schema name: Schema # 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: Schema
+ ],
+ "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: Schema
+ },
+ "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",
+ ],
+ "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
+ "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+ "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
+ "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+ "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
+ "nullable": True or False, # Optional. Indicates if the value may be null.
+ "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY.
+ # Object with schema name: Schema
+ ],
+ "properties": { # Optional. Properties of Type.OBJECT.
+ "a_key": # Object with schema name: Schema
+ },
+ "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", # Required. The type of the data.
+ "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
+ },
+ "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the output arguments of the MCP tool.
+ "additionalProperties": # Object with schema name: Schema # 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: Schema
+ ],
+ "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: Schema
+ },
+ "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",
+ ],
+ "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY.
+ "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+ "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER.
+ "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+ "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER.
+ "nullable": True or False, # Optional. Indicates if the value may be null.
+ "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY.
+ # Object with schema name: Schema
+ ],
+ "properties": { # Optional. Properties of Type.OBJECT.
+ "a_key": # Object with schema name: Schema
+ },
+ "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", # Required. The type of the data.
+ "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
+ },
+ },
+ "tool": "A String", # Required. The original name of the tool as it is emitted by the MCP server.
+ },
+ ],
+ },
+ "name": "A String", # Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
+ "openApiToolset": { # A toolset that contains a list of tools that are defined by an OpenAPI schema. # Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema.
+ "apiAuthentication": { # Authentication information required for API calls. # Optional. Authentication information required by the API.
+ "apiKeyConfig": { # Configurations for authentication with API key. # Optional. Config for API key auth.
+ "apiKeySecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name.
+ "requestLocation": "A String", # Required. Key location in the request.
+ },
+ "bearerTokenConfig": { # Configurations for authentication with a bearer token. # Optional. Config for bearer token auth.
+ "token": "A String", # Required. The bearer token. Must be in the format `$context.variables.`.
+ },
+ "oauthConfig": { # Configurations for authentication with OAuth. # Optional. Config for OAuth.
+ "clientId": "A String", # Required. The client ID from the OAuth provider.
+ "clientSecretVersion": "A String", # Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ "oauthGrantType": "A String", # Required. OAuth grant types.
+ "scopes": [ # Optional. The OAuth scopes to grant.
+ "A String",
+ ],
+ "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
+ },
+ "serviceAccountAuthConfig": { # Configurations for authentication using a custom service account. # Optional. Config for service account authentication.
+ "scopes": [ # Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used.
+ "A String",
+ ],
+ "serviceAccount": "A String", # Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`.
+ },
+ "serviceAgentIdTokenAuthConfig": { # Configurations for authentication with [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. # Optional. Config for ID token auth generated from CES service agent.
+ },
+ },
+ "ignoreUnknownFields": True or False, # Optional. If true, the agent will ignore unknown fields in the API response for all operations defined in the OpenAPI schema.
+ "openApiSchema": "A String", # Required. The OpenAPI schema of the toolset.
+ "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration.
+ "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app.
+ },
+ "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates
+ "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
+ { # The CA certificate.
+ "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ```
+ "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
+ },
+ ],
+ },
+ "url": "A String", # Optional. The server URL of the Open API schema. This field is only set in toolsets in the environment dependencies during the export process if the schema contains a server url. During the import process, if this url is present in the environment dependencies and the schema has the $env_var placeholder, it will replace the placeholder in the schema.
+ },
+ "timeout": "A String", # Optional. The timeout for the toolset execution. If not set, the default timeout is 30 seconds for `SYNCHRONOUS` toolsets and 60 seconds for `ASYNCHRONOUS` toolsets.
+ "toolFakeConfig": { # Configuration for tool behavior in fake mode. # Optional. Configuration for tools behavior in fake mode.
+ "codeBlock": { # A code block to be executed instead of a real tool call. # Optional. Code block which will be executed instead of a real tool call.
+ "pythonCode": "A String", # Required. Python code which will be invoked in tool fake mode. Expected Python function signature - To catch all tool calls: def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: To catch a specific tool call: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: If the function returns None, the real tool will be invoked instead.
+ },
+ "enableFakeMode": True or False, # Optional. Whether the tool is using fake mode.
+ },
+ "updateTime": "A String", # Output only. Timestamp when the toolset was last updated.
+ },
+ ],
+ },
+ "updateTime": "A String", # Output only. Timestamp when the app version was last updated.
+}
+restore(name, body=None, x__xgafv=None)
Restores the specified app version. This will create a new app version from the current draft app and overwrite the current draft with the specified app version.
diff --git a/googleapiclient/discovery_cache/documents/ces.v1.json b/googleapiclient/discovery_cache/documents/ces.v1.json
index c137c6f636..6e05f0d36a 100644
--- a/googleapiclient/discovery_cache/documents/ces.v1.json
+++ b/googleapiclient/discovery_cache/documents/ces.v1.json
@@ -2317,6 +2317,41 @@
"https://www.googleapis.com/auth/cloud-platform"
]
},
+"patch": {
+"description": "Updates the specified app version.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions/{versionsId}",
+"httpMethod": "PATCH",
+"id": "ces.projects.locations.apps.versions.patch",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Identifier. The unique identifier of the app version. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/versions/[^/]+$",
+"required": true,
+"type": "string"
+},
+"updateMask": {
+"description": "Optional. The list of fields to update. If empty, fields `display_name` and `description` will be updated.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"request": {
+"$ref": "AppVersion"
+},
+"response": {
+"$ref": "AppVersion"
+},
+"scopes": [
+"https://www.googleapis.com/auth/ces",
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
"restore": {
"description": "Restores the specified app version. This will create a new app version from the current draft app and overwrite the current draft with the specified app version.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions/{versionsId}:restore",
@@ -2551,7 +2586,7 @@
}
}
},
-"revision": "20260824",
+"revision": "20260903",
"rootUrl": "https://ces.googleapis.com/",
"schemas": {
"Action": {
@@ -2713,6 +2748,10 @@
"description": "Identifier. The unique identifier of the agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`",
"type": "string"
},
+"remoteA2aAgent": {
+"$ref": "AgentRemoteA2aAgent",
+"description": "Optional. The remote [A2A](https://github.com/a2aproject/A2A) agent to be used for the agent execution."
+},
"remoteDialogflowAgent": {
"$ref": "AgentRemoteDialogflowAgent",
"description": "Optional. The remote [Dialogflow](https://cloud.google.com/dialogflow/cx/docs/concept/console-conversational-agents) agent to be used for the agent execution. If this field is set, all other agent level properties will be ignored. Note: If the Dialogflow agent is in a different project from the app, you should grant `roles/dialogflow.client` to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`."
@@ -2835,6 +2874,29 @@
"properties": {},
"type": "object"
},
+"AgentRegistryDeployment": {
+"description": "Configuration and status for Agent Registry deployment.",
+"id": "AgentRegistryDeployment",
+"properties": {
+"agentRegistryServiceName": {
+"description": "Optional. Output only. The resource name of the deployed Agent Registry service. Format: `projects/{project}/locations/{location}/services/{service}`",
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
+"AgentRemoteA2aAgent": {
+"description": "The agent which will transfer execution to a remote [A2A](https://github.com/a2aproject/A2A) agent.",
+"id": "AgentRemoteA2aAgent",
+"properties": {
+"a2aConfig": {
+"$ref": "RemoteA2aConfig",
+"description": "Required. The A2A connection configuration."
+}
+},
+"type": "object"
+},
"AgentRemoteDialogflowAgent": {
"description": "The agent which will transfer execution to a remote [Dialogflow CX](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent. The Dialogflow agent will process subsequent user queries until the session ends or flow ends, and the control is transferred back to the parent CES agent.",
"id": "AgentRemoteDialogflowAgent",
@@ -3309,6 +3371,12 @@
"$ref": "AppSnapshot",
"description": "Output only. The snapshot of the app when the version is created.",
"readOnly": true
+},
+"updateTime": {
+"description": "Output only. Timestamp when the app version was last updated.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
}
},
"type": "object"
@@ -3325,6 +3393,13 @@
"$ref": "BargeInConfig",
"description": "Optional. Configures the agent behavior for the user barge-in activities."
},
+"customVoiceSamples": {
+"description": "Optional. Configures custom voice samples for voice cloning.",
+"items": {
+"$ref": "CustomVoiceSample"
+},
+"type": "array"
+},
"inactivityTimeout": {
"description": "Optional. The duration of user inactivity (no speech or interaction) before the agent prompts the user for reengagement. If not set, the agent will not prompt the user for reengagement.",
"format": "google-duration",
@@ -3835,6 +3910,13 @@
"$ref": "CitationsCitedChunk"
},
"type": "array"
+},
+"inlineCitations": {
+"description": "Optional. List of inline citations in the agent response.",
+"items": {
+"$ref": "CitationsInlineCitation"
+},
+"type": "array"
}
},
"type": "object"
@@ -3862,6 +3944,31 @@
},
"type": "object"
},
+"CitationsInlineCitation": {
+"description": "An inline citation in the response text.",
+"id": "CitationsInlineCitation",
+"properties": {
+"citedChunkIndices": {
+"description": "The indices of the cited chunks that back this text segment. Indices refer to the elements in `cited_chunks`.",
+"items": {
+"format": "int32",
+"type": "integer"
+},
+"type": "array"
+},
+"endIndex": {
+"description": "The ending index (in bytes) of the text segment in the agent response.",
+"format": "int32",
+"type": "integer"
+},
+"startIndex": {
+"description": "The starting index (in bytes) of the text segment in the agent response.",
+"format": "int32",
+"type": "integer"
+}
+},
+"type": "object"
+},
"ClientCertificateSettings": {
"description": "Settings for custom client certificates.",
"id": "ClientCertificateSettings",
@@ -4141,6 +4248,39 @@
},
"type": "object"
},
+"CustomVoiceSample": {
+"description": "Configuration for a custom voice sample used for voice cloning.",
+"id": "CustomVoiceSample",
+"properties": {
+"consentAudioGcsUri": {
+"description": "Optional. Consent audio for voice cloning.",
+"type": "string"
+},
+"name": {
+"description": "Optional. The user-defined name for the custom voice sample.",
+"type": "string"
+},
+"previewAudioContent": {
+"description": "Output only. Synthesized preview audio for custom voice, formatted as canonical WAV (LINEAR16, 24kHz, 16-bit, mono).",
+"format": "byte",
+"readOnly": true,
+"type": "string"
+},
+"previewText": {
+"description": "Optional. Text for synthesizing preview audio for custom voice.",
+"type": "string"
+},
+"voiceInstruction": {
+"description": "Optional. Natural language instructions for voice style, tone, pacing, or pronunciation.",
+"type": "string"
+},
+"voiceSampleGcsUri": {
+"description": "Optional. The Cloud Storage URI to the audio sample for voice cloning. The audio sample should be a mono-channel, 24kHz WAV file.",
+"type": "string"
+}
+},
+"type": "object"
+},
"DashboardSettings": {
"description": "Settings for dashboards associated with the app, that show up in the Monitoring view.",
"id": "DashboardSettings",
@@ -4599,6 +4739,10 @@
"description": "A deployment represents an immutable, queryable version of the app. It is used to deploy an app version with a specific channel profile.",
"id": "Deployment",
"properties": {
+"agentRegistryDeployment": {
+"$ref": "AgentRegistryDeployment",
+"description": "Optional. Configuration for deploying this deployment to Agent Registry. If present, this deployment will be published to Agent Registry."
+},
"appVersion": {
"description": "Optional. The resource name of the app version to deploy. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` Use `projects/{project}/locations/{location}/apps/{app}/versions/-` to use the draft app.",
"type": "string"
@@ -5642,6 +5786,10 @@
"description": "Represents an image input or output in the conversation.",
"id": "Image",
"properties": {
+"altText": {
+"description": "Optional. The alternative text for the image.",
+"type": "string"
+},
"data": {
"description": "Required. Raw bytes of the image.",
"format": "byte",
@@ -7599,6 +7747,47 @@
},
"type": "object"
},
+"RemoteA2aConfig": {
+"description": "Shared configuration for connecting to a remote [A2A](https://github.com/a2aproject/A2A) agent.",
+"id": "RemoteA2aConfig",
+"properties": {
+"agentCard": {
+"$ref": "AgentCard",
+"description": "Optional. The full agent card defined inline."
+},
+"agentRegistry": {
+"description": "Optional. Reference to the agent in the Agent Registry. Format: `projects/{project}/locations/{location}/agents/{agent}`",
+"type": "string"
+},
+"apiAuthentication": {
+"$ref": "ApiAuthentication",
+"description": "Optional. Authentication configuration for calling the remote agent. Optional if the registry reference already handles authentication."
+},
+"contextId": {
+"description": "Optional. If not empty, interactions with the remote A2A agent will use this context ID. This context_id field can refer to a session variable like `$context.variables.order_agent_session_id`.",
+"type": "string"
+},
+"inputVariableMapping": {
+"additionalProperties": {
+"type": "string"
+},
+"description": "Optional. Mapping of input variable names of remote agent to GECX variable names.",
+"type": "object"
+},
+"outputVariableMapping": {
+"additionalProperties": {
+"type": "string"
+},
+"description": "Optional. Mapping of output variable names of remote agent to GECX variable names.",
+"type": "object"
+},
+"streamingEnabled": {
+"description": "Optional. Whether streaming is enabled for the remote agent.",
+"type": "boolean"
+}
+},
+"type": "object"
+},
"RemoteAgentTool": {
"description": "Represents a tool that allows the agent to call another remote agent.",
"id": "RemoteAgentTool",
@@ -8096,6 +8285,10 @@
"description": "Custom payload with structured output from the CES agent.",
"type": "object"
},
+"progress": {
+"description": "Intermediate progress update from the CES agent.",
+"type": "string"
+},
"text": {
"description": "Output text from the CES agent.",
"type": "string"
diff --git a/googleapiclient/discovery_cache/documents/ces.v1beta.json b/googleapiclient/discovery_cache/documents/ces.v1beta.json
index a447933eb9..f23f0a1f17 100644
--- a/googleapiclient/discovery_cache/documents/ces.v1beta.json
+++ b/googleapiclient/discovery_cache/documents/ces.v1beta.json
@@ -3605,6 +3605,41 @@
"https://www.googleapis.com/auth/cloud-platform"
]
},
+"patch": {
+"description": "Updates the specified app version.",
+"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions/{versionsId}",
+"httpMethod": "PATCH",
+"id": "ces.projects.locations.apps.versions.patch",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Identifier. The unique identifier of the app version. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/versions/[^/]+$",
+"required": true,
+"type": "string"
+},
+"updateMask": {
+"description": "Optional. The list of fields to update. If empty, fields `display_name` and `description` will be updated.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta/{+name}",
+"request": {
+"$ref": "AppVersion"
+},
+"response": {
+"$ref": "AppVersion"
+},
+"scopes": [
+"https://www.googleapis.com/auth/ces",
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
"restore": {
"description": "Restores the specified app version. This will create a new app version from the current draft app and overwrite the current draft with the specified app version.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions/{versionsId}:restore",
@@ -3839,7 +3874,7 @@
}
}
},
-"revision": "20260824",
+"revision": "20260903",
"rootUrl": "https://ces.googleapis.com/",
"schemas": {
"Action": {
@@ -4001,6 +4036,10 @@
"description": "Identifier. The unique identifier of the agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`",
"type": "string"
},
+"remoteA2aAgent": {
+"$ref": "AgentRemoteA2aAgent",
+"description": "Optional. The remote [A2A](https://github.com/a2aproject/A2A) agent to be used for the agent execution."
+},
"remoteDialogflowAgent": {
"$ref": "AgentRemoteDialogflowAgent",
"description": "Optional. The remote [Dialogflow](https://cloud.google.com/dialogflow/cx/docs/concept/console-conversational-agents) agent to be used for the agent execution. If this field is set, all other agent level properties will be ignored. Note: If the Dialogflow agent is in a different project from the app, you should grant `roles/dialogflow.client` to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`."
@@ -4123,6 +4162,29 @@
"properties": {},
"type": "object"
},
+"AgentRegistryDeployment": {
+"description": "Configuration and status for Agent Registry deployment.",
+"id": "AgentRegistryDeployment",
+"properties": {
+"agentRegistryServiceName": {
+"description": "Optional. Output only. The resource name of the deployed Agent Registry service. Format: `projects/{project}/locations/{location}/services/{service}`",
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
+"AgentRemoteA2aAgent": {
+"description": "The agent which will transfer execution to a remote [A2A](https://github.com/a2aproject/A2A) agent.",
+"id": "AgentRemoteA2aAgent",
+"properties": {
+"a2aConfig": {
+"$ref": "RemoteA2aConfig",
+"description": "Required. The A2A connection configuration."
+}
+},
+"type": "object"
+},
"AgentRemoteDialogflowAgent": {
"description": "The agent which will transfer execution to a remote [Dialogflow CX](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent. The Dialogflow agent will process subsequent user queries until the session ends or flow ends, and the control is transferred back to the parent CES agent.",
"id": "AgentRemoteDialogflowAgent",
@@ -4829,6 +4891,12 @@
"$ref": "AppSnapshot",
"description": "Output only. The snapshot of the app when the version is created.",
"readOnly": true
+},
+"updateTime": {
+"description": "Output only. Timestamp when the app version was last updated.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
}
},
"type": "object"
@@ -4845,6 +4913,13 @@
"$ref": "BargeInConfig",
"description": "Optional. Configures the agent behavior for the user barge-in activities."
},
+"customVoiceSamples": {
+"description": "Optional. Configures custom voice samples for voice cloning.",
+"items": {
+"$ref": "CustomVoiceSample"
+},
+"type": "array"
+},
"inactivityTimeout": {
"description": "Optional. The duration of user inactivity (no speech or interaction) before the agent prompts the user for reengagement. If not set, the agent will not prompt the user for reengagement.",
"format": "google-duration",
@@ -5383,6 +5458,13 @@
"$ref": "CitationsCitedChunk"
},
"type": "array"
+},
+"inlineCitations": {
+"description": "Optional. List of inline citations in the agent response.",
+"items": {
+"$ref": "CitationsInlineCitation"
+},
+"type": "array"
}
},
"type": "object"
@@ -5410,6 +5492,31 @@
},
"type": "object"
},
+"CitationsInlineCitation": {
+"description": "An inline citation in the response text.",
+"id": "CitationsInlineCitation",
+"properties": {
+"citedChunkIndices": {
+"description": "The indices of the cited chunks that back this text segment. Indices refer to the elements in `cited_chunks`.",
+"items": {
+"format": "int32",
+"type": "integer"
+},
+"type": "array"
+},
+"endIndex": {
+"description": "The ending index (in bytes) of the text segment in the agent response.",
+"format": "int32",
+"type": "integer"
+},
+"startIndex": {
+"description": "The starting index (in bytes) of the text segment in the agent response.",
+"format": "int32",
+"type": "integer"
+}
+},
+"type": "object"
+},
"ClientCertificateSettings": {
"description": "Settings for custom client certificates.",
"id": "ClientCertificateSettings",
@@ -5689,6 +5796,39 @@
},
"type": "object"
},
+"CustomVoiceSample": {
+"description": "Configuration for a custom voice sample used for voice cloning.",
+"id": "CustomVoiceSample",
+"properties": {
+"consentAudioGcsUri": {
+"description": "Optional. Consent audio for voice cloning.",
+"type": "string"
+},
+"name": {
+"description": "Optional. The user-defined name for the custom voice sample.",
+"type": "string"
+},
+"previewAudioContent": {
+"description": "Output only. Synthesized preview audio for custom voice, formatted as canonical WAV (LINEAR16, 24kHz, 16-bit, mono).",
+"format": "byte",
+"readOnly": true,
+"type": "string"
+},
+"previewText": {
+"description": "Optional. Text for synthesizing preview audio for custom voice.",
+"type": "string"
+},
+"voiceInstruction": {
+"description": "Optional. Natural language instructions for voice style, tone, pacing, or pronunciation.",
+"type": "string"
+},
+"voiceSampleGcsUri": {
+"description": "Optional. The Cloud Storage URI to the audio sample for voice cloning. The audio sample should be a mono-channel, 24kHz WAV file.",
+"type": "string"
+}
+},
+"type": "object"
+},
"DashboardSettings": {
"description": "Settings for dashboards associated with the app, that show up in the Monitoring view.",
"id": "DashboardSettings",
@@ -6153,6 +6293,10 @@
"description": "A deployment represents an immutable, queryable version of the app. It is used to deploy an app version with a specific channel profile.",
"id": "Deployment",
"properties": {
+"agentRegistryDeployment": {
+"$ref": "AgentRegistryDeployment",
+"description": "Optional. Configuration for deploying this deployment to Agent Registry. If present, this deployment will be published to Agent Registry."
+},
"appVersion": {
"description": "Optional. The resource name of the app version to deploy. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` Use `projects/{project}/locations/{location}/apps/{app}/versions/-` to use the draft app.",
"type": "string"
@@ -9687,6 +9831,10 @@
"description": "Represents an image input or output in the conversation.",
"id": "Image",
"properties": {
+"altText": {
+"description": "Optional. The alternative text for the image.",
+"type": "string"
+},
"data": {
"description": "Required. Raw bytes of the image.",
"format": "byte",
@@ -12185,6 +12333,47 @@
},
"type": "object"
},
+"RemoteA2aConfig": {
+"description": "Shared configuration for connecting to a remote [A2A](https://github.com/a2aproject/A2A) agent.",
+"id": "RemoteA2aConfig",
+"properties": {
+"agentCard": {
+"$ref": "AgentCard",
+"description": "Optional. The full agent card defined inline."
+},
+"agentRegistry": {
+"description": "Optional. Reference to the agent in the Agent Registry. Format: `projects/{project}/locations/{location}/agents/{agent}`",
+"type": "string"
+},
+"apiAuthentication": {
+"$ref": "ApiAuthentication",
+"description": "Optional. Authentication configuration for calling the remote agent. Optional if the registry reference already handles authentication."
+},
+"contextId": {
+"description": "Optional. If not empty, interactions with the remote A2A agent will use this context ID. This context_id field can refer to a session variable like `$context.variables.order_agent_session_id`.",
+"type": "string"
+},
+"inputVariableMapping": {
+"additionalProperties": {
+"type": "string"
+},
+"description": "Optional. Mapping of input variable names of remote agent to GECX variable names.",
+"type": "object"
+},
+"outputVariableMapping": {
+"additionalProperties": {
+"type": "string"
+},
+"description": "Optional. Mapping of output variable names of remote agent to GECX variable names.",
+"type": "object"
+},
+"streamingEnabled": {
+"description": "Optional. Whether streaming is enabled for the remote agent.",
+"type": "boolean"
+}
+},
+"type": "object"
+},
"RemoteAgentTool": {
"description": "Represents a tool that allows the agent to call another remote agent.",
"id": "RemoteAgentTool",
@@ -12901,6 +13090,10 @@
"description": "Custom payload with structured output from the CES agent.",
"type": "object"
},
+"progress": {
+"description": "Intermediate progress update from the CES agent.",
+"type": "string"
+},
"text": {
"description": "Output text from the CES agent.",
"type": "string"
From 41decd6a2cd466777f0155d177343c3992d081e4 Mon Sep 17 00:00:00 2001
From: Yoshi Automation
Date: Tue, 8 Sep 2026 07:20:11 +0000
Subject: [PATCH 11/40] feat(cloudbilling): update the api
#### cloudbilling:v1
The following keys were added:
- resources.message.methods.send (Total Keys: 8)
- resources.message.methods.stream (Total Keys: 8)
- resources.tasks.methods.cancel (Total Keys: 12)
- resources.tasks.methods.get (Total Keys: 16)
- resources.tasks.methods.subscribe (Total Keys: 13)
- resources.tasks.resources.pushNotificationConfigs.methods.create (Total Keys: 16)
- resources.tasks.resources.pushNotificationConfigs.methods.delete (Total Keys: 13)
- resources.tasks.resources.pushNotificationConfigs.methods.get (Total Keys: 13)
- resources.tasks.resources.pushNotificationConfigs.methods.list (Total Keys: 18)
- resources.v1.methods.getCard (Total Keys: 9)
- schemas.APIKeySecurityScheme (Total Keys: 4)
- schemas.AgentCapabilities (Total Keys: 6)
- schemas.AgentCard (Total Keys: 29)
- schemas.AgentExtension (Total Keys: 6)
- schemas.AgentInterface (Total Keys: 4)
- schemas.AgentProvider (Total Keys: 3)
- schemas.AgentSkill (Total Keys: 14)
- schemas.Artifact (Total Keys: 10)
- schemas.AuthenticationInfo (Total Keys: 5)
- schemas.AuthorizationCodeOAuthFlow (Total Keys: 4)
- schemas.CancelTaskRequest (Total Keys: 3)
- schemas.ClientCredentialsOAuthFlow (Total Keys: 4)
- schemas.DataPart (Total Keys: 4)
- schemas.Empty (Total Keys: 2)
- schemas.FilePart (Total Keys: 7)
- schemas.HTTPAuthSecurityScheme (Total Keys: 4)
- schemas.ImplicitOAuthFlow (Total Keys: 4)
- schemas.ListTaskPushNotificationConfigResponse (Total Keys: 5)
- schemas.Message (Total Keys: 12)
- schemas.MutualTlsSecurityScheme (Total Keys: 2)
- schemas.OAuth2SecurityScheme (Total Keys: 3)
- schemas.OAuthFlows (Total Keys: 6)
- schemas.OpenIdConnectSecurityScheme (Total Keys: 2)
- schemas.Part (Total Keys: 7)
- schemas.PasswordOAuthFlow (Total Keys: 4)
- schemas.PushNotificationConfig (Total Keys: 5)
- schemas.Security (Total Keys: 11)
- schemas.SendMessageConfiguration (Total Keys: 8)
- schemas.SendMessageRequest (Total Keys: 7)
- schemas.SendMessageResponse (Total Keys: 4)
- schemas.StreamResponse (Total Keys: 6)
- schemas.StringList (Total Keys: 4)
- schemas.Task (Total Keys: 38)
---
docs/dyn/cloudbilling_v1.html | 15 +
docs/dyn/cloudbilling_v1.message.html | 602 ++++++++
docs/dyn/cloudbilling_v1.tasks.html | 594 ++++++++
...ling_v1.tasks.pushNotificationConfigs.html | 253 ++++
docs/dyn/cloudbilling_v1.v1.html | 253 ++++
.../documents/cloudbilling.v1.json | 1297 ++++++++++++++++-
6 files changed, 3013 insertions(+), 1 deletion(-)
create mode 100644 docs/dyn/cloudbilling_v1.message.html
create mode 100644 docs/dyn/cloudbilling_v1.tasks.html
create mode 100644 docs/dyn/cloudbilling_v1.tasks.pushNotificationConfigs.html
create mode 100644 docs/dyn/cloudbilling_v1.v1.html
diff --git a/docs/dyn/cloudbilling_v1.html b/docs/dyn/cloudbilling_v1.html
index 8ca2042b30..33b79ffa1f 100644
--- a/docs/dyn/cloudbilling_v1.html
+++ b/docs/dyn/cloudbilling_v1.html
@@ -79,6 +79,11 @@ Instance Methods
Returns the billingAccounts Resource.
+
+ message()
+
+Returns the message Resource.
+
@@ -94,6 +99,16 @@ Instance Methods
Returns the services Resource.
+
+ tasks()
+
+Returns the tasks Resource.
+
+
+ v1()
+
+Returns the v1 Resource.
+
Close httplib2 connections.
diff --git a/docs/dyn/cloudbilling_v1.message.html b/docs/dyn/cloudbilling_v1.message.html
new file mode 100644
index 0000000000..07df8067d5
--- /dev/null
+++ b/docs/dyn/cloudbilling_v1.message.html
@@ -0,0 +1,602 @@
+
+
+
+Cloud Billing API . message
+Instance Methods
+
+ close()
+Close httplib2 connections.
+
+ send(body=None, x__xgafv=None)
+Send a message to the agent. This is a blocking call that will return the task once it is completed, or a LRO if requested.
+
+ stream(body=None, x__xgafv=None)
+SendStreamingMessage is a streaming call that will return a stream of task update events until the Task is in an interrupted or terminal state.
+Method Details
+
+ close()
+ Close httplib2 connections.
+
+
+
+ send(body=None, x__xgafv=None)
+ Send a message to the agent. This is a blocking call that will return the task once it is completed, or a LRO if requested.
+
+Args:
+ body: object, The request body.
+ The object takes the form of:
+
+{ # /////////// Request Messages ///////////
+ "configuration": { # Configuration of a send message request. # Configuration for the send request.
+ "acceptedOutputModes": [ # The output modes that the agent is expected to respond with.
+ "A String",
+ ],
+ "blocking": True or False, # If true, the message will be blocking until the task is completed. If false, the message will be non-blocking and the task will be returned immediately. It is the caller's responsibility to check for any task updates.
+ "historyLength": 42, # The maximum number of messages to include in the history. if 0, the history will be unlimited.
+ "pushNotification": { # Configuration for setting up push notifications for task updates. # A configuration of a webhook that can be used to receive updates
+ "authentication": { # Defines authentication details, used for push notifications. # Information about the authentication to sent with the notification
+ "credentials": "A String", # Optional credentials
+ "schemes": [ # Supported authentication schemes - e.g. Basic, Bearer, etc
+ "A String",
+ ],
+ },
+ "id": "A String", # A unique identifier (e.g. UUID) for this push notification.
+ "token": "A String", # Token unique for this task/session
+ "url": "A String", # Url to send the notification too
+ },
+ },
+ "message": { # Message is one unit of communication between client and server. It is associated with a context and optionally a task. Since the server is responsible for the context definition, it must always provide a context_id in its messages. The client can optionally provide the context_id if it knows the context to associate the message to. Similarly for task_id, except the server decides if a task is created and whether to include the task_id. # Required. The message to send to the agent.
+ "content": [ # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED Content is the container of the message content.
+ { # Part represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON).
+ "data": { # DataPart represents a structured blob. This is most commonly a JSON payload.
+ "data": {
+ "a_key": "", # Properties of the object.
+ },
+ },
+ "file": { # FilePart represents the different ways files can be provided. If files are small, directly feeding the bytes is supported via file_with_bytes. If the file is large, the agent should read the content as appropriate directly from the file_with_uri source.
+ "fileWithBytes": "A String",
+ "fileWithUri": "A String",
+ "mimeType": "A String",
+ "name": "A String",
+ },
+ "metadata": { # Optional metadata associated with this part.
+ "a_key": "", # Properties of the object.
+ },
+ "text": "A String",
+ },
+ ],
+ "contextId": "A String", # The context id of the message. This is optional and if set, the message will be associated with the given context.
+ "extensions": [ # The URIs of extensions that are present or contributed to this Message.
+ "A String",
+ ],
+ "messageId": "A String", # The unique identifier (e.g. UUID)of the message. This is required and created by the message creator.
+ "metadata": { # protolint:enable REPEATED_FIELD_NAMES_PLURALIZED Any optional metadata to provide along with the message.
+ "a_key": "", # Properties of the object.
+ },
+ "role": "A String", # A role for the message.
+ "taskId": "A String", # The task id of the message. This is optional and if set, the message will be associated with the given task.
+ },
+ "metadata": { # Optional metadata for the request.
+ "a_key": "", # Properties of the object.
+ },
+ "tenant": "A String", # Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # ////// Response Messages ///////////
+ "message": { # Message is one unit of communication between client and server. It is associated with a context and optionally a task. Since the server is responsible for the context definition, it must always provide a context_id in its messages. The client can optionally provide the context_id if it knows the context to associate the message to. Similarly for task_id, except the server decides if a task is created and whether to include the task_id.
+ "content": [ # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED Content is the container of the message content.
+ { # Part represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON).
+ "data": { # DataPart represents a structured blob. This is most commonly a JSON payload.
+ "data": {
+ "a_key": "", # Properties of the object.
+ },
+ },
+ "file": { # FilePart represents the different ways files can be provided. If files are small, directly feeding the bytes is supported via file_with_bytes. If the file is large, the agent should read the content as appropriate directly from the file_with_uri source.
+ "fileWithBytes": "A String",
+ "fileWithUri": "A String",
+ "mimeType": "A String",
+ "name": "A String",
+ },
+ "metadata": { # Optional metadata associated with this part.
+ "a_key": "", # Properties of the object.
+ },
+ "text": "A String",
+ },
+ ],
+ "contextId": "A String", # The context id of the message. This is optional and if set, the message will be associated with the given context.
+ "extensions": [ # The URIs of extensions that are present or contributed to this Message.
+ "A String",
+ ],
+ "messageId": "A String", # The unique identifier (e.g. UUID)of the message. This is required and created by the message creator.
+ "metadata": { # protolint:enable REPEATED_FIELD_NAMES_PLURALIZED Any optional metadata to provide along with the message.
+ "a_key": "", # Properties of the object.
+ },
+ "role": "A String", # A role for the message.
+ "taskId": "A String", # The task id of the message. This is optional and if set, the message will be associated with the given task.
+ },
+ "task": { # Task is the core unit of action for A2A. It has a current status and when results are created for the task they are stored in the artifact. If there are multiple turns for a task, these are stored in history.
+ "artifacts": [ # A set of output artifacts for a Task.
+ { # Artifacts are the container for task completed results. These are similar to Messages but are intended to be the product of a task, as opposed to point-to-point communication.
+ "artifactId": "A String", # Unique identifier (e.g. UUID) for the artifact. It must be at least unique within a task.
+ "description": "A String", # A human readable description of the artifact, optional.
+ "extensions": [ # The URIs of extensions that are present or contributed to this Artifact.
+ "A String",
+ ],
+ "metadata": { # Optional metadata included with the artifact.
+ "a_key": "", # Properties of the object.
+ },
+ "name": "A String", # A human readable name for the artifact.
+ "parts": [ # The content of the artifact.
+ { # Part represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON).
+ "data": { # DataPart represents a structured blob. This is most commonly a JSON payload.
+ "data": {
+ "a_key": "", # Properties of the object.
+ },
+ },
+ "file": { # FilePart represents the different ways files can be provided. If files are small, directly feeding the bytes is supported via file_with_bytes. If the file is large, the agent should read the content as appropriate directly from the file_with_uri source.
+ "fileWithBytes": "A String",
+ "fileWithUri": "A String",
+ "mimeType": "A String",
+ "name": "A String",
+ },
+ "metadata": { # Optional metadata associated with this part.
+ "a_key": "", # Properties of the object.
+ },
+ "text": "A String",
+ },
+ ],
+ },
+ ],
+ "contextId": "A String", # Unique identifier (e.g. UUID) for the contextual collection of interactions (tasks and messages). Created by the A2A server.
+ "history": [ # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED The history of interactions from a task.
+ { # Message is one unit of communication between client and server. It is associated with a context and optionally a task. Since the server is responsible for the context definition, it must always provide a context_id in its messages. The client can optionally provide the context_id if it knows the context to associate the message to. Similarly for task_id, except the server decides if a task is created and whether to include the task_id.
+ "content": [ # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED Content is the container of the message content.
+ { # Part represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON).
+ "data": { # DataPart represents a structured blob. This is most commonly a JSON payload.
+ "data": {
+ "a_key": "", # Properties of the object.
+ },
+ },
+ "file": { # FilePart represents the different ways files can be provided. If files are small, directly feeding the bytes is supported via file_with_bytes. If the file is large, the agent should read the content as appropriate directly from the file_with_uri source.
+ "fileWithBytes": "A String",
+ "fileWithUri": "A String",
+ "mimeType": "A String",
+ "name": "A String",
+ },
+ "metadata": { # Optional metadata associated with this part.
+ "a_key": "", # Properties of the object.
+ },
+ "text": "A String",
+ },
+ ],
+ "contextId": "A String", # The context id of the message. This is optional and if set, the message will be associated with the given context.
+ "extensions": [ # The URIs of extensions that are present or contributed to this Message.
+ "A String",
+ ],
+ "messageId": "A String", # The unique identifier (e.g. UUID)of the message. This is required and created by the message creator.
+ "metadata": { # protolint:enable REPEATED_FIELD_NAMES_PLURALIZED Any optional metadata to provide along with the message.
+ "a_key": "", # Properties of the object.
+ },
+ "role": "A String", # A role for the message.
+ "taskId": "A String", # The task id of the message. This is optional and if set, the message will be associated with the given task.
+ },
+ ],
+ "id": "A String", # Unique identifier (e.g. UUID) for the task, generated by the server for a new task.
+ "metadata": { # protolint:enable REPEATED_FIELD_NAMES_PLURALIZED A key/value object to store custom metadata about a task.
+ "a_key": "", # Properties of the object.
+ },
+ "status": { # A container for the status of a task # The current status of a Task, including state and a message.
+ "message": { # Message is one unit of communication between client and server. It is associated with a context and optionally a task. Since the server is responsible for the context definition, it must always provide a context_id in its messages. The client can optionally provide the context_id if it knows the context to associate the message to. Similarly for task_id, except the server decides if a task is created and whether to include the task_id. # A message associated with the status.
+ "content": [ # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED Content is the container of the message content.
+ { # Part represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON).
+ "data": { # DataPart represents a structured blob. This is most commonly a JSON payload.
+ "data": {
+ "a_key": "", # Properties of the object.
+ },
+ },
+ "file": { # FilePart represents the different ways files can be provided. If files are small, directly feeding the bytes is supported via file_with_bytes. If the file is large, the agent should read the content as appropriate directly from the file_with_uri source.
+ "fileWithBytes": "A String",
+ "fileWithUri": "A String",
+ "mimeType": "A String",
+ "name": "A String",
+ },
+ "metadata": { # Optional metadata associated with this part.
+ "a_key": "", # Properties of the object.
+ },
+ "text": "A String",
+ },
+ ],
+ "contextId": "A String", # The context id of the message. This is optional and if set, the message will be associated with the given context.
+ "extensions": [ # The URIs of extensions that are present or contributed to this Message.
+ "A String",
+ ],
+ "messageId": "A String", # The unique identifier (e.g. UUID)of the message. This is required and created by the message creator.
+ "metadata": { # protolint:enable REPEATED_FIELD_NAMES_PLURALIZED Any optional metadata to provide along with the message.
+ "a_key": "", # Properties of the object.
+ },
+ "role": "A String", # A role for the message.
+ "taskId": "A String", # The task id of the message. This is optional and if set, the message will be associated with the given task.
+ },
+ "state": "A String", # The current state of this task
+ "timestamp": "A String", # Timestamp when the status was recorded. Example: "2023-10-27T10:00:00Z"
+ },
+ },
+}
+
+
+
+ stream(body=None, x__xgafv=None)
+ SendStreamingMessage is a streaming call that will return a stream of task update events until the Task is in an interrupted or terminal state.
+
+Args:
+ body: object, The request body.
+ The object takes the form of:
+
+{ # /////////// Request Messages ///////////
+ "configuration": { # Configuration of a send message request. # Configuration for the send request.
+ "acceptedOutputModes": [ # The output modes that the agent is expected to respond with.
+ "A String",
+ ],
+ "blocking": True or False, # If true, the message will be blocking until the task is completed. If false, the message will be non-blocking and the task will be returned immediately. It is the caller's responsibility to check for any task updates.
+ "historyLength": 42, # The maximum number of messages to include in the history. if 0, the history will be unlimited.
+ "pushNotification": { # Configuration for setting up push notifications for task updates. # A configuration of a webhook that can be used to receive updates
+ "authentication": { # Defines authentication details, used for push notifications. # Information about the authentication to sent with the notification
+ "credentials": "A String", # Optional credentials
+ "schemes": [ # Supported authentication schemes - e.g. Basic, Bearer, etc
+ "A String",
+ ],
+ },
+ "id": "A String", # A unique identifier (e.g. UUID) for this push notification.
+ "token": "A String", # Token unique for this task/session
+ "url": "A String", # Url to send the notification too
+ },
+ },
+ "message": { # Message is one unit of communication between client and server. It is associated with a context and optionally a task. Since the server is responsible for the context definition, it must always provide a context_id in its messages. The client can optionally provide the context_id if it knows the context to associate the message to. Similarly for task_id, except the server decides if a task is created and whether to include the task_id. # Required. The message to send to the agent.
+ "content": [ # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED Content is the container of the message content.
+ { # Part represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON).
+ "data": { # DataPart represents a structured blob. This is most commonly a JSON payload.
+ "data": {
+ "a_key": "", # Properties of the object.
+ },
+ },
+ "file": { # FilePart represents the different ways files can be provided. If files are small, directly feeding the bytes is supported via file_with_bytes. If the file is large, the agent should read the content as appropriate directly from the file_with_uri source.
+ "fileWithBytes": "A String",
+ "fileWithUri": "A String",
+ "mimeType": "A String",
+ "name": "A String",
+ },
+ "metadata": { # Optional metadata associated with this part.
+ "a_key": "", # Properties of the object.
+ },
+ "text": "A String",
+ },
+ ],
+ "contextId": "A String", # The context id of the message. This is optional and if set, the message will be associated with the given context.
+ "extensions": [ # The URIs of extensions that are present or contributed to this Message.
+ "A String",
+ ],
+ "messageId": "A String", # The unique identifier (e.g. UUID)of the message. This is required and created by the message creator.
+ "metadata": { # protolint:enable REPEATED_FIELD_NAMES_PLURALIZED Any optional metadata to provide along with the message.
+ "a_key": "", # Properties of the object.
+ },
+ "role": "A String", # A role for the message.
+ "taskId": "A String", # The task id of the message. This is optional and if set, the message will be associated with the given task.
+ },
+ "metadata": { # Optional metadata for the request.
+ "a_key": "", # Properties of the object.
+ },
+ "tenant": "A String", # Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The stream response for a message. The stream should be one of the following sequences: If the response is a message, the stream should contain one, and only one, message and then close If the response is a task lifecycle, the first response should be a Task object followed by zero or more TaskStatusUpdateEvents and TaskArtifactUpdateEvents. The stream should complete when the Task if in an interrupted or terminal state. A stream that ends before these conditions are met are
+ "artifactUpdate": { # TaskArtifactUpdateEvent represents a task delta where an artifact has been generated.
+ "append": True or False, # Whether this should be appended to a prior one produced
+ "artifact": { # Artifacts are the container for task completed results. These are similar to Messages but are intended to be the product of a task, as opposed to point-to-point communication. # The artifact itself
+ "artifactId": "A String", # Unique identifier (e.g. UUID) for the artifact. It must be at least unique within a task.
+ "description": "A String", # A human readable description of the artifact, optional.
+ "extensions": [ # The URIs of extensions that are present or contributed to this Artifact.
+ "A String",
+ ],
+ "metadata": { # Optional metadata included with the artifact.
+ "a_key": "", # Properties of the object.
+ },
+ "name": "A String", # A human readable name for the artifact.
+ "parts": [ # The content of the artifact.
+ { # Part represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON).
+ "data": { # DataPart represents a structured blob. This is most commonly a JSON payload.
+ "data": {
+ "a_key": "", # Properties of the object.
+ },
+ },
+ "file": { # FilePart represents the different ways files can be provided. If files are small, directly feeding the bytes is supported via file_with_bytes. If the file is large, the agent should read the content as appropriate directly from the file_with_uri source.
+ "fileWithBytes": "A String",
+ "fileWithUri": "A String",
+ "mimeType": "A String",
+ "name": "A String",
+ },
+ "metadata": { # Optional metadata associated with this part.
+ "a_key": "", # Properties of the object.
+ },
+ "text": "A String",
+ },
+ ],
+ },
+ "contextId": "A String", # The id of the context that this task belongs too
+ "lastChunk": True or False, # Whether this represents the last part of an artifact
+ "metadata": { # Optional metadata associated with the artifact update.
+ "a_key": "", # Properties of the object.
+ },
+ "taskId": "A String", # The id of the task for this artifact
+ },
+ "message": { # Message is one unit of communication between client and server. It is associated with a context and optionally a task. Since the server is responsible for the context definition, it must always provide a context_id in its messages. The client can optionally provide the context_id if it knows the context to associate the message to. Similarly for task_id, except the server decides if a task is created and whether to include the task_id.
+ "content": [ # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED Content is the container of the message content.
+ { # Part represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON).
+ "data": { # DataPart represents a structured blob. This is most commonly a JSON payload.
+ "data": {
+ "a_key": "", # Properties of the object.
+ },
+ },
+ "file": { # FilePart represents the different ways files can be provided. If files are small, directly feeding the bytes is supported via file_with_bytes. If the file is large, the agent should read the content as appropriate directly from the file_with_uri source.
+ "fileWithBytes": "A String",
+ "fileWithUri": "A String",
+ "mimeType": "A String",
+ "name": "A String",
+ },
+ "metadata": { # Optional metadata associated with this part.
+ "a_key": "", # Properties of the object.
+ },
+ "text": "A String",
+ },
+ ],
+ "contextId": "A String", # The context id of the message. This is optional and if set, the message will be associated with the given context.
+ "extensions": [ # The URIs of extensions that are present or contributed to this Message.
+ "A String",
+ ],
+ "messageId": "A String", # The unique identifier (e.g. UUID)of the message. This is required and created by the message creator.
+ "metadata": { # protolint:enable REPEATED_FIELD_NAMES_PLURALIZED Any optional metadata to provide along with the message.
+ "a_key": "", # Properties of the object.
+ },
+ "role": "A String", # A role for the message.
+ "taskId": "A String", # The task id of the message. This is optional and if set, the message will be associated with the given task.
+ },
+ "statusUpdate": { # TaskStatusUpdateEvent is a delta even on a task indicating that a task has changed.
+ "contextId": "A String", # The id of the context that the task belongs to
+ "final": True or False, # Whether this is the last status update expected for this task.
+ "metadata": { # Optional metadata to associate with the task update.
+ "a_key": "", # Properties of the object.
+ },
+ "status": { # A container for the status of a task # The new status of the task.
+ "message": { # Message is one unit of communication between client and server. It is associated with a context and optionally a task. Since the server is responsible for the context definition, it must always provide a context_id in its messages. The client can optionally provide the context_id if it knows the context to associate the message to. Similarly for task_id, except the server decides if a task is created and whether to include the task_id. # A message associated with the status.
+ "content": [ # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED Content is the container of the message content.
+ { # Part represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON).
+ "data": { # DataPart represents a structured blob. This is most commonly a JSON payload.
+ "data": {
+ "a_key": "", # Properties of the object.
+ },
+ },
+ "file": { # FilePart represents the different ways files can be provided. If files are small, directly feeding the bytes is supported via file_with_bytes. If the file is large, the agent should read the content as appropriate directly from the file_with_uri source.
+ "fileWithBytes": "A String",
+ "fileWithUri": "A String",
+ "mimeType": "A String",
+ "name": "A String",
+ },
+ "metadata": { # Optional metadata associated with this part.
+ "a_key": "", # Properties of the object.
+ },
+ "text": "A String",
+ },
+ ],
+ "contextId": "A String", # The context id of the message. This is optional and if set, the message will be associated with the given context.
+ "extensions": [ # The URIs of extensions that are present or contributed to this Message.
+ "A String",
+ ],
+ "messageId": "A String", # The unique identifier (e.g. UUID)of the message. This is required and created by the message creator.
+ "metadata": { # protolint:enable REPEATED_FIELD_NAMES_PLURALIZED Any optional metadata to provide along with the message.
+ "a_key": "", # Properties of the object.
+ },
+ "role": "A String", # A role for the message.
+ "taskId": "A String", # The task id of the message. This is optional and if set, the message will be associated with the given task.
+ },
+ "state": "A String", # The current state of this task
+ "timestamp": "A String", # Timestamp when the status was recorded. Example: "2023-10-27T10:00:00Z"
+ },
+ "taskId": "A String", # The id of the task that is changed
+ },
+ "task": { # Task is the core unit of action for A2A. It has a current status and when results are created for the task they are stored in the artifact. If there are multiple turns for a task, these are stored in history.
+ "artifacts": [ # A set of output artifacts for a Task.
+ { # Artifacts are the container for task completed results. These are similar to Messages but are intended to be the product of a task, as opposed to point-to-point communication.
+ "artifactId": "A String", # Unique identifier (e.g. UUID) for the artifact. It must be at least unique within a task.
+ "description": "A String", # A human readable description of the artifact, optional.
+ "extensions": [ # The URIs of extensions that are present or contributed to this Artifact.
+ "A String",
+ ],
+ "metadata": { # Optional metadata included with the artifact.
+ "a_key": "", # Properties of the object.
+ },
+ "name": "A String", # A human readable name for the artifact.
+ "parts": [ # The content of the artifact.
+ { # Part represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON).
+ "data": { # DataPart represents a structured blob. This is most commonly a JSON payload.
+ "data": {
+ "a_key": "", # Properties of the object.
+ },
+ },
+ "file": { # FilePart represents the different ways files can be provided. If files are small, directly feeding the bytes is supported via file_with_bytes. If the file is large, the agent should read the content as appropriate directly from the file_with_uri source.
+ "fileWithBytes": "A String",
+ "fileWithUri": "A String",
+ "mimeType": "A String",
+ "name": "A String",
+ },
+ "metadata": { # Optional metadata associated with this part.
+ "a_key": "", # Properties of the object.
+ },
+ "text": "A String",
+ },
+ ],
+ },
+ ],
+ "contextId": "A String", # Unique identifier (e.g. UUID) for the contextual collection of interactions (tasks and messages). Created by the A2A server.
+ "history": [ # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED The history of interactions from a task.
+ { # Message is one unit of communication between client and server. It is associated with a context and optionally a task. Since the server is responsible for the context definition, it must always provide a context_id in its messages. The client can optionally provide the context_id if it knows the context to associate the message to. Similarly for task_id, except the server decides if a task is created and whether to include the task_id.
+ "content": [ # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED Content is the container of the message content.
+ { # Part represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON).
+ "data": { # DataPart represents a structured blob. This is most commonly a JSON payload.
+ "data": {
+ "a_key": "", # Properties of the object.
+ },
+ },
+ "file": { # FilePart represents the different ways files can be provided. If files are small, directly feeding the bytes is supported via file_with_bytes. If the file is large, the agent should read the content as appropriate directly from the file_with_uri source.
+ "fileWithBytes": "A String",
+ "fileWithUri": "A String",
+ "mimeType": "A String",
+ "name": "A String",
+ },
+ "metadata": { # Optional metadata associated with this part.
+ "a_key": "", # Properties of the object.
+ },
+ "text": "A String",
+ },
+ ],
+ "contextId": "A String", # The context id of the message. This is optional and if set, the message will be associated with the given context.
+ "extensions": [ # The URIs of extensions that are present or contributed to this Message.
+ "A String",
+ ],
+ "messageId": "A String", # The unique identifier (e.g. UUID)of the message. This is required and created by the message creator.
+ "metadata": { # protolint:enable REPEATED_FIELD_NAMES_PLURALIZED Any optional metadata to provide along with the message.
+ "a_key": "", # Properties of the object.
+ },
+ "role": "A String", # A role for the message.
+ "taskId": "A String", # The task id of the message. This is optional and if set, the message will be associated with the given task.
+ },
+ ],
+ "id": "A String", # Unique identifier (e.g. UUID) for the task, generated by the server for a new task.
+ "metadata": { # protolint:enable REPEATED_FIELD_NAMES_PLURALIZED A key/value object to store custom metadata about a task.
+ "a_key": "", # Properties of the object.
+ },
+ "status": { # A container for the status of a task # The current status of a Task, including state and a message.
+ "message": { # Message is one unit of communication between client and server. It is associated with a context and optionally a task. Since the server is responsible for the context definition, it must always provide a context_id in its messages. The client can optionally provide the context_id if it knows the context to associate the message to. Similarly for task_id, except the server decides if a task is created and whether to include the task_id. # A message associated with the status.
+ "content": [ # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED Content is the container of the message content.
+ { # Part represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON).
+ "data": { # DataPart represents a structured blob. This is most commonly a JSON payload.
+ "data": {
+ "a_key": "", # Properties of the object.
+ },
+ },
+ "file": { # FilePart represents the different ways files can be provided. If files are small, directly feeding the bytes is supported via file_with_bytes. If the file is large, the agent should read the content as appropriate directly from the file_with_uri source.
+ "fileWithBytes": "A String",
+ "fileWithUri": "A String",
+ "mimeType": "A String",
+ "name": "A String",
+ },
+ "metadata": { # Optional metadata associated with this part.
+ "a_key": "", # Properties of the object.
+ },
+ "text": "A String",
+ },
+ ],
+ "contextId": "A String", # The context id of the message. This is optional and if set, the message will be associated with the given context.
+ "extensions": [ # The URIs of extensions that are present or contributed to this Message.
+ "A String",
+ ],
+ "messageId": "A String", # The unique identifier (e.g. UUID)of the message. This is required and created by the message creator.
+ "metadata": { # protolint:enable REPEATED_FIELD_NAMES_PLURALIZED Any optional metadata to provide along with the message.
+ "a_key": "", # Properties of the object.
+ },
+ "role": "A String", # A role for the message.
+ "taskId": "A String", # The task id of the message. This is optional and if set, the message will be associated with the given task.
+ },
+ "state": "A String", # The current state of this task
+ "timestamp": "A String", # Timestamp when the status was recorded. Example: "2023-10-27T10:00:00Z"
+ },
+ },
+}
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/cloudbilling_v1.tasks.html b/docs/dyn/cloudbilling_v1.tasks.html
new file mode 100644
index 0000000000..6fb2ceadd5
--- /dev/null
+++ b/docs/dyn/cloudbilling_v1.tasks.html
@@ -0,0 +1,594 @@
+
+
+
+Cloud Billing API . tasks
+Instance Methods
+
+Returns the pushNotificationConfigs Resource.
+
+
+ cancel(name, body=None, x__xgafv=None)
+Cancel a task from the agent. If supported one should expect no more task updates for the task.
+
+ close()
+Close httplib2 connections.
+
+ get(name, historyLength=None, tenant=None, x__xgafv=None)
+Get the current state of a task from the agent.
+
+ subscribe(name, tenant=None, x__xgafv=None)
+TaskSubscription is a streaming call that will return a stream of task update events. This attaches the stream to an existing in process task. If the task is complete the stream will return the completed task (like GetTask) and close the stream.
+Method Details
+
+ cancel(name, body=None, x__xgafv=None)
+ Cancel a task from the agent. If supported one should expect no more task updates for the task.
+
+Args:
+ name: string, The resource name of the task to cancel. Format: tasks/{task_id} (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "tenant": "A String", # Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Task is the core unit of action for A2A. It has a current status and when results are created for the task they are stored in the artifact. If there are multiple turns for a task, these are stored in history.
+ "artifacts": [ # A set of output artifacts for a Task.
+ { # Artifacts are the container for task completed results. These are similar to Messages but are intended to be the product of a task, as opposed to point-to-point communication.
+ "artifactId": "A String", # Unique identifier (e.g. UUID) for the artifact. It must be at least unique within a task.
+ "description": "A String", # A human readable description of the artifact, optional.
+ "extensions": [ # The URIs of extensions that are present or contributed to this Artifact.
+ "A String",
+ ],
+ "metadata": { # Optional metadata included with the artifact.
+ "a_key": "", # Properties of the object.
+ },
+ "name": "A String", # A human readable name for the artifact.
+ "parts": [ # The content of the artifact.
+ { # Part represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON).
+ "data": { # DataPart represents a structured blob. This is most commonly a JSON payload.
+ "data": {
+ "a_key": "", # Properties of the object.
+ },
+ },
+ "file": { # FilePart represents the different ways files can be provided. If files are small, directly feeding the bytes is supported via file_with_bytes. If the file is large, the agent should read the content as appropriate directly from the file_with_uri source.
+ "fileWithBytes": "A String",
+ "fileWithUri": "A String",
+ "mimeType": "A String",
+ "name": "A String",
+ },
+ "metadata": { # Optional metadata associated with this part.
+ "a_key": "", # Properties of the object.
+ },
+ "text": "A String",
+ },
+ ],
+ },
+ ],
+ "contextId": "A String", # Unique identifier (e.g. UUID) for the contextual collection of interactions (tasks and messages). Created by the A2A server.
+ "history": [ # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED The history of interactions from a task.
+ { # Message is one unit of communication between client and server. It is associated with a context and optionally a task. Since the server is responsible for the context definition, it must always provide a context_id in its messages. The client can optionally provide the context_id if it knows the context to associate the message to. Similarly for task_id, except the server decides if a task is created and whether to include the task_id.
+ "content": [ # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED Content is the container of the message content.
+ { # Part represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON).
+ "data": { # DataPart represents a structured blob. This is most commonly a JSON payload.
+ "data": {
+ "a_key": "", # Properties of the object.
+ },
+ },
+ "file": { # FilePart represents the different ways files can be provided. If files are small, directly feeding the bytes is supported via file_with_bytes. If the file is large, the agent should read the content as appropriate directly from the file_with_uri source.
+ "fileWithBytes": "A String",
+ "fileWithUri": "A String",
+ "mimeType": "A String",
+ "name": "A String",
+ },
+ "metadata": { # Optional metadata associated with this part.
+ "a_key": "", # Properties of the object.
+ },
+ "text": "A String",
+ },
+ ],
+ "contextId": "A String", # The context id of the message. This is optional and if set, the message will be associated with the given context.
+ "extensions": [ # The URIs of extensions that are present or contributed to this Message.
+ "A String",
+ ],
+ "messageId": "A String", # The unique identifier (e.g. UUID)of the message. This is required and created by the message creator.
+ "metadata": { # protolint:enable REPEATED_FIELD_NAMES_PLURALIZED Any optional metadata to provide along with the message.
+ "a_key": "", # Properties of the object.
+ },
+ "role": "A String", # A role for the message.
+ "taskId": "A String", # The task id of the message. This is optional and if set, the message will be associated with the given task.
+ },
+ ],
+ "id": "A String", # Unique identifier (e.g. UUID) for the task, generated by the server for a new task.
+ "metadata": { # protolint:enable REPEATED_FIELD_NAMES_PLURALIZED A key/value object to store custom metadata about a task.
+ "a_key": "", # Properties of the object.
+ },
+ "status": { # A container for the status of a task # The current status of a Task, including state and a message.
+ "message": { # Message is one unit of communication between client and server. It is associated with a context and optionally a task. Since the server is responsible for the context definition, it must always provide a context_id in its messages. The client can optionally provide the context_id if it knows the context to associate the message to. Similarly for task_id, except the server decides if a task is created and whether to include the task_id. # A message associated with the status.
+ "content": [ # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED Content is the container of the message content.
+ { # Part represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON).
+ "data": { # DataPart represents a structured blob. This is most commonly a JSON payload.
+ "data": {
+ "a_key": "", # Properties of the object.
+ },
+ },
+ "file": { # FilePart represents the different ways files can be provided. If files are small, directly feeding the bytes is supported via file_with_bytes. If the file is large, the agent should read the content as appropriate directly from the file_with_uri source.
+ "fileWithBytes": "A String",
+ "fileWithUri": "A String",
+ "mimeType": "A String",
+ "name": "A String",
+ },
+ "metadata": { # Optional metadata associated with this part.
+ "a_key": "", # Properties of the object.
+ },
+ "text": "A String",
+ },
+ ],
+ "contextId": "A String", # The context id of the message. This is optional and if set, the message will be associated with the given context.
+ "extensions": [ # The URIs of extensions that are present or contributed to this Message.
+ "A String",
+ ],
+ "messageId": "A String", # The unique identifier (e.g. UUID)of the message. This is required and created by the message creator.
+ "metadata": { # protolint:enable REPEATED_FIELD_NAMES_PLURALIZED Any optional metadata to provide along with the message.
+ "a_key": "", # Properties of the object.
+ },
+ "role": "A String", # A role for the message.
+ "taskId": "A String", # The task id of the message. This is optional and if set, the message will be associated with the given task.
+ },
+ "state": "A String", # The current state of this task
+ "timestamp": "A String", # Timestamp when the status was recorded. Example: "2023-10-27T10:00:00Z"
+ },
+}
+
+
+
+ close()
+ Close httplib2 connections.
+
+
+
+ get(name, historyLength=None, tenant=None, x__xgafv=None)
+ Get the current state of a task from the agent.
+
+Args:
+ name: string, Required. The resource name of the task. Format: tasks/{task_id} (required)
+ historyLength: integer, The number of most recent messages from the task's history to retrieve.
+ tenant: string, Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Task is the core unit of action for A2A. It has a current status and when results are created for the task they are stored in the artifact. If there are multiple turns for a task, these are stored in history.
+ "artifacts": [ # A set of output artifacts for a Task.
+ { # Artifacts are the container for task completed results. These are similar to Messages but are intended to be the product of a task, as opposed to point-to-point communication.
+ "artifactId": "A String", # Unique identifier (e.g. UUID) for the artifact. It must be at least unique within a task.
+ "description": "A String", # A human readable description of the artifact, optional.
+ "extensions": [ # The URIs of extensions that are present or contributed to this Artifact.
+ "A String",
+ ],
+ "metadata": { # Optional metadata included with the artifact.
+ "a_key": "", # Properties of the object.
+ },
+ "name": "A String", # A human readable name for the artifact.
+ "parts": [ # The content of the artifact.
+ { # Part represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON).
+ "data": { # DataPart represents a structured blob. This is most commonly a JSON payload.
+ "data": {
+ "a_key": "", # Properties of the object.
+ },
+ },
+ "file": { # FilePart represents the different ways files can be provided. If files are small, directly feeding the bytes is supported via file_with_bytes. If the file is large, the agent should read the content as appropriate directly from the file_with_uri source.
+ "fileWithBytes": "A String",
+ "fileWithUri": "A String",
+ "mimeType": "A String",
+ "name": "A String",
+ },
+ "metadata": { # Optional metadata associated with this part.
+ "a_key": "", # Properties of the object.
+ },
+ "text": "A String",
+ },
+ ],
+ },
+ ],
+ "contextId": "A String", # Unique identifier (e.g. UUID) for the contextual collection of interactions (tasks and messages). Created by the A2A server.
+ "history": [ # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED The history of interactions from a task.
+ { # Message is one unit of communication between client and server. It is associated with a context and optionally a task. Since the server is responsible for the context definition, it must always provide a context_id in its messages. The client can optionally provide the context_id if it knows the context to associate the message to. Similarly for task_id, except the server decides if a task is created and whether to include the task_id.
+ "content": [ # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED Content is the container of the message content.
+ { # Part represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON).
+ "data": { # DataPart represents a structured blob. This is most commonly a JSON payload.
+ "data": {
+ "a_key": "", # Properties of the object.
+ },
+ },
+ "file": { # FilePart represents the different ways files can be provided. If files are small, directly feeding the bytes is supported via file_with_bytes. If the file is large, the agent should read the content as appropriate directly from the file_with_uri source.
+ "fileWithBytes": "A String",
+ "fileWithUri": "A String",
+ "mimeType": "A String",
+ "name": "A String",
+ },
+ "metadata": { # Optional metadata associated with this part.
+ "a_key": "", # Properties of the object.
+ },
+ "text": "A String",
+ },
+ ],
+ "contextId": "A String", # The context id of the message. This is optional and if set, the message will be associated with the given context.
+ "extensions": [ # The URIs of extensions that are present or contributed to this Message.
+ "A String",
+ ],
+ "messageId": "A String", # The unique identifier (e.g. UUID)of the message. This is required and created by the message creator.
+ "metadata": { # protolint:enable REPEATED_FIELD_NAMES_PLURALIZED Any optional metadata to provide along with the message.
+ "a_key": "", # Properties of the object.
+ },
+ "role": "A String", # A role for the message.
+ "taskId": "A String", # The task id of the message. This is optional and if set, the message will be associated with the given task.
+ },
+ ],
+ "id": "A String", # Unique identifier (e.g. UUID) for the task, generated by the server for a new task.
+ "metadata": { # protolint:enable REPEATED_FIELD_NAMES_PLURALIZED A key/value object to store custom metadata about a task.
+ "a_key": "", # Properties of the object.
+ },
+ "status": { # A container for the status of a task # The current status of a Task, including state and a message.
+ "message": { # Message is one unit of communication between client and server. It is associated with a context and optionally a task. Since the server is responsible for the context definition, it must always provide a context_id in its messages. The client can optionally provide the context_id if it knows the context to associate the message to. Similarly for task_id, except the server decides if a task is created and whether to include the task_id. # A message associated with the status.
+ "content": [ # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED Content is the container of the message content.
+ { # Part represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON).
+ "data": { # DataPart represents a structured blob. This is most commonly a JSON payload.
+ "data": {
+ "a_key": "", # Properties of the object.
+ },
+ },
+ "file": { # FilePart represents the different ways files can be provided. If files are small, directly feeding the bytes is supported via file_with_bytes. If the file is large, the agent should read the content as appropriate directly from the file_with_uri source.
+ "fileWithBytes": "A String",
+ "fileWithUri": "A String",
+ "mimeType": "A String",
+ "name": "A String",
+ },
+ "metadata": { # Optional metadata associated with this part.
+ "a_key": "", # Properties of the object.
+ },
+ "text": "A String",
+ },
+ ],
+ "contextId": "A String", # The context id of the message. This is optional and if set, the message will be associated with the given context.
+ "extensions": [ # The URIs of extensions that are present or contributed to this Message.
+ "A String",
+ ],
+ "messageId": "A String", # The unique identifier (e.g. UUID)of the message. This is required and created by the message creator.
+ "metadata": { # protolint:enable REPEATED_FIELD_NAMES_PLURALIZED Any optional metadata to provide along with the message.
+ "a_key": "", # Properties of the object.
+ },
+ "role": "A String", # A role for the message.
+ "taskId": "A String", # The task id of the message. This is optional and if set, the message will be associated with the given task.
+ },
+ "state": "A String", # The current state of this task
+ "timestamp": "A String", # Timestamp when the status was recorded. Example: "2023-10-27T10:00:00Z"
+ },
+}
+
+
+
+ subscribe(name, tenant=None, x__xgafv=None)
+ TaskSubscription is a streaming call that will return a stream of task update events. This attaches the stream to an existing in process task. If the task is complete the stream will return the completed task (like GetTask) and close the stream.
+
+Args:
+ name: string, The resource name of the task to subscribe to. Format: tasks/{task_id} (required)
+ tenant: string, Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The stream response for a message. The stream should be one of the following sequences: If the response is a message, the stream should contain one, and only one, message and then close If the response is a task lifecycle, the first response should be a Task object followed by zero or more TaskStatusUpdateEvents and TaskArtifactUpdateEvents. The stream should complete when the Task if in an interrupted or terminal state. A stream that ends before these conditions are met are
+ "artifactUpdate": { # TaskArtifactUpdateEvent represents a task delta where an artifact has been generated.
+ "append": True or False, # Whether this should be appended to a prior one produced
+ "artifact": { # Artifacts are the container for task completed results. These are similar to Messages but are intended to be the product of a task, as opposed to point-to-point communication. # The artifact itself
+ "artifactId": "A String", # Unique identifier (e.g. UUID) for the artifact. It must be at least unique within a task.
+ "description": "A String", # A human readable description of the artifact, optional.
+ "extensions": [ # The URIs of extensions that are present or contributed to this Artifact.
+ "A String",
+ ],
+ "metadata": { # Optional metadata included with the artifact.
+ "a_key": "", # Properties of the object.
+ },
+ "name": "A String", # A human readable name for the artifact.
+ "parts": [ # The content of the artifact.
+ { # Part represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON).
+ "data": { # DataPart represents a structured blob. This is most commonly a JSON payload.
+ "data": {
+ "a_key": "", # Properties of the object.
+ },
+ },
+ "file": { # FilePart represents the different ways files can be provided. If files are small, directly feeding the bytes is supported via file_with_bytes. If the file is large, the agent should read the content as appropriate directly from the file_with_uri source.
+ "fileWithBytes": "A String",
+ "fileWithUri": "A String",
+ "mimeType": "A String",
+ "name": "A String",
+ },
+ "metadata": { # Optional metadata associated with this part.
+ "a_key": "", # Properties of the object.
+ },
+ "text": "A String",
+ },
+ ],
+ },
+ "contextId": "A String", # The id of the context that this task belongs too
+ "lastChunk": True or False, # Whether this represents the last part of an artifact
+ "metadata": { # Optional metadata associated with the artifact update.
+ "a_key": "", # Properties of the object.
+ },
+ "taskId": "A String", # The id of the task for this artifact
+ },
+ "message": { # Message is one unit of communication between client and server. It is associated with a context and optionally a task. Since the server is responsible for the context definition, it must always provide a context_id in its messages. The client can optionally provide the context_id if it knows the context to associate the message to. Similarly for task_id, except the server decides if a task is created and whether to include the task_id.
+ "content": [ # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED Content is the container of the message content.
+ { # Part represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON).
+ "data": { # DataPart represents a structured blob. This is most commonly a JSON payload.
+ "data": {
+ "a_key": "", # Properties of the object.
+ },
+ },
+ "file": { # FilePart represents the different ways files can be provided. If files are small, directly feeding the bytes is supported via file_with_bytes. If the file is large, the agent should read the content as appropriate directly from the file_with_uri source.
+ "fileWithBytes": "A String",
+ "fileWithUri": "A String",
+ "mimeType": "A String",
+ "name": "A String",
+ },
+ "metadata": { # Optional metadata associated with this part.
+ "a_key": "", # Properties of the object.
+ },
+ "text": "A String",
+ },
+ ],
+ "contextId": "A String", # The context id of the message. This is optional and if set, the message will be associated with the given context.
+ "extensions": [ # The URIs of extensions that are present or contributed to this Message.
+ "A String",
+ ],
+ "messageId": "A String", # The unique identifier (e.g. UUID)of the message. This is required and created by the message creator.
+ "metadata": { # protolint:enable REPEATED_FIELD_NAMES_PLURALIZED Any optional metadata to provide along with the message.
+ "a_key": "", # Properties of the object.
+ },
+ "role": "A String", # A role for the message.
+ "taskId": "A String", # The task id of the message. This is optional and if set, the message will be associated with the given task.
+ },
+ "statusUpdate": { # TaskStatusUpdateEvent is a delta even on a task indicating that a task has changed.
+ "contextId": "A String", # The id of the context that the task belongs to
+ "final": True or False, # Whether this is the last status update expected for this task.
+ "metadata": { # Optional metadata to associate with the task update.
+ "a_key": "", # Properties of the object.
+ },
+ "status": { # A container for the status of a task # The new status of the task.
+ "message": { # Message is one unit of communication between client and server. It is associated with a context and optionally a task. Since the server is responsible for the context definition, it must always provide a context_id in its messages. The client can optionally provide the context_id if it knows the context to associate the message to. Similarly for task_id, except the server decides if a task is created and whether to include the task_id. # A message associated with the status.
+ "content": [ # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED Content is the container of the message content.
+ { # Part represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON).
+ "data": { # DataPart represents a structured blob. This is most commonly a JSON payload.
+ "data": {
+ "a_key": "", # Properties of the object.
+ },
+ },
+ "file": { # FilePart represents the different ways files can be provided. If files are small, directly feeding the bytes is supported via file_with_bytes. If the file is large, the agent should read the content as appropriate directly from the file_with_uri source.
+ "fileWithBytes": "A String",
+ "fileWithUri": "A String",
+ "mimeType": "A String",
+ "name": "A String",
+ },
+ "metadata": { # Optional metadata associated with this part.
+ "a_key": "", # Properties of the object.
+ },
+ "text": "A String",
+ },
+ ],
+ "contextId": "A String", # The context id of the message. This is optional and if set, the message will be associated with the given context.
+ "extensions": [ # The URIs of extensions that are present or contributed to this Message.
+ "A String",
+ ],
+ "messageId": "A String", # The unique identifier (e.g. UUID)of the message. This is required and created by the message creator.
+ "metadata": { # protolint:enable REPEATED_FIELD_NAMES_PLURALIZED Any optional metadata to provide along with the message.
+ "a_key": "", # Properties of the object.
+ },
+ "role": "A String", # A role for the message.
+ "taskId": "A String", # The task id of the message. This is optional and if set, the message will be associated with the given task.
+ },
+ "state": "A String", # The current state of this task
+ "timestamp": "A String", # Timestamp when the status was recorded. Example: "2023-10-27T10:00:00Z"
+ },
+ "taskId": "A String", # The id of the task that is changed
+ },
+ "task": { # Task is the core unit of action for A2A. It has a current status and when results are created for the task they are stored in the artifact. If there are multiple turns for a task, these are stored in history.
+ "artifacts": [ # A set of output artifacts for a Task.
+ { # Artifacts are the container for task completed results. These are similar to Messages but are intended to be the product of a task, as opposed to point-to-point communication.
+ "artifactId": "A String", # Unique identifier (e.g. UUID) for the artifact. It must be at least unique within a task.
+ "description": "A String", # A human readable description of the artifact, optional.
+ "extensions": [ # The URIs of extensions that are present or contributed to this Artifact.
+ "A String",
+ ],
+ "metadata": { # Optional metadata included with the artifact.
+ "a_key": "", # Properties of the object.
+ },
+ "name": "A String", # A human readable name for the artifact.
+ "parts": [ # The content of the artifact.
+ { # Part represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON).
+ "data": { # DataPart represents a structured blob. This is most commonly a JSON payload.
+ "data": {
+ "a_key": "", # Properties of the object.
+ },
+ },
+ "file": { # FilePart represents the different ways files can be provided. If files are small, directly feeding the bytes is supported via file_with_bytes. If the file is large, the agent should read the content as appropriate directly from the file_with_uri source.
+ "fileWithBytes": "A String",
+ "fileWithUri": "A String",
+ "mimeType": "A String",
+ "name": "A String",
+ },
+ "metadata": { # Optional metadata associated with this part.
+ "a_key": "", # Properties of the object.
+ },
+ "text": "A String",
+ },
+ ],
+ },
+ ],
+ "contextId": "A String", # Unique identifier (e.g. UUID) for the contextual collection of interactions (tasks and messages). Created by the A2A server.
+ "history": [ # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED The history of interactions from a task.
+ { # Message is one unit of communication between client and server. It is associated with a context and optionally a task. Since the server is responsible for the context definition, it must always provide a context_id in its messages. The client can optionally provide the context_id if it knows the context to associate the message to. Similarly for task_id, except the server decides if a task is created and whether to include the task_id.
+ "content": [ # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED Content is the container of the message content.
+ { # Part represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON).
+ "data": { # DataPart represents a structured blob. This is most commonly a JSON payload.
+ "data": {
+ "a_key": "", # Properties of the object.
+ },
+ },
+ "file": { # FilePart represents the different ways files can be provided. If files are small, directly feeding the bytes is supported via file_with_bytes. If the file is large, the agent should read the content as appropriate directly from the file_with_uri source.
+ "fileWithBytes": "A String",
+ "fileWithUri": "A String",
+ "mimeType": "A String",
+ "name": "A String",
+ },
+ "metadata": { # Optional metadata associated with this part.
+ "a_key": "", # Properties of the object.
+ },
+ "text": "A String",
+ },
+ ],
+ "contextId": "A String", # The context id of the message. This is optional and if set, the message will be associated with the given context.
+ "extensions": [ # The URIs of extensions that are present or contributed to this Message.
+ "A String",
+ ],
+ "messageId": "A String", # The unique identifier (e.g. UUID)of the message. This is required and created by the message creator.
+ "metadata": { # protolint:enable REPEATED_FIELD_NAMES_PLURALIZED Any optional metadata to provide along with the message.
+ "a_key": "", # Properties of the object.
+ },
+ "role": "A String", # A role for the message.
+ "taskId": "A String", # The task id of the message. This is optional and if set, the message will be associated with the given task.
+ },
+ ],
+ "id": "A String", # Unique identifier (e.g. UUID) for the task, generated by the server for a new task.
+ "metadata": { # protolint:enable REPEATED_FIELD_NAMES_PLURALIZED A key/value object to store custom metadata about a task.
+ "a_key": "", # Properties of the object.
+ },
+ "status": { # A container for the status of a task # The current status of a Task, including state and a message.
+ "message": { # Message is one unit of communication between client and server. It is associated with a context and optionally a task. Since the server is responsible for the context definition, it must always provide a context_id in its messages. The client can optionally provide the context_id if it knows the context to associate the message to. Similarly for task_id, except the server decides if a task is created and whether to include the task_id. # A message associated with the status.
+ "content": [ # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED Content is the container of the message content.
+ { # Part represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON).
+ "data": { # DataPart represents a structured blob. This is most commonly a JSON payload.
+ "data": {
+ "a_key": "", # Properties of the object.
+ },
+ },
+ "file": { # FilePart represents the different ways files can be provided. If files are small, directly feeding the bytes is supported via file_with_bytes. If the file is large, the agent should read the content as appropriate directly from the file_with_uri source.
+ "fileWithBytes": "A String",
+ "fileWithUri": "A String",
+ "mimeType": "A String",
+ "name": "A String",
+ },
+ "metadata": { # Optional metadata associated with this part.
+ "a_key": "", # Properties of the object.
+ },
+ "text": "A String",
+ },
+ ],
+ "contextId": "A String", # The context id of the message. This is optional and if set, the message will be associated with the given context.
+ "extensions": [ # The URIs of extensions that are present or contributed to this Message.
+ "A String",
+ ],
+ "messageId": "A String", # The unique identifier (e.g. UUID)of the message. This is required and created by the message creator.
+ "metadata": { # protolint:enable REPEATED_FIELD_NAMES_PLURALIZED Any optional metadata to provide along with the message.
+ "a_key": "", # Properties of the object.
+ },
+ "role": "A String", # A role for the message.
+ "taskId": "A String", # The task id of the message. This is optional and if set, the message will be associated with the given task.
+ },
+ "state": "A String", # The current state of this task
+ "timestamp": "A String", # Timestamp when the status was recorded. Example: "2023-10-27T10:00:00Z"
+ },
+ },
+}
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/cloudbilling_v1.tasks.pushNotificationConfigs.html b/docs/dyn/cloudbilling_v1.tasks.pushNotificationConfigs.html
new file mode 100644
index 0000000000..c47fea31b8
--- /dev/null
+++ b/docs/dyn/cloudbilling_v1.tasks.pushNotificationConfigs.html
@@ -0,0 +1,253 @@
+
+
+
+Cloud Billing API . tasks . pushNotificationConfigs
+Instance Methods
+
+ close()
+Close httplib2 connections.
+
+ create(parent, body=None, configId=None, tenant=None, x__xgafv=None)
+Set a push notification config for a task.
+
+ delete(name, tenant=None, x__xgafv=None)
+Delete a push notification config for a task.
+
+ get(name, tenant=None, x__xgafv=None)
+Get a push notification config for a task.
+
+ list(parent, pageSize=None, pageToken=None, tenant=None, x__xgafv=None)
+Get a list of push notifications configured for a task.
+
+ list_next(previous_request, previous_response)
+Retrieves the next page of results.
+Method Details
+
+ close()
+ Close httplib2 connections.
+
+
+
+ create(parent, body=None, configId=None, tenant=None, x__xgafv=None)
+ Set a push notification config for a task.
+
+Args:
+ parent: string, Required. The parent task resource for this config. Format: tasks/{task_id} (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "name": "A String", # The resource name of the config. Format: tasks/{task_id}/pushNotificationConfigs/{config_id}
+ "pushNotificationConfig": { # Configuration for setting up push notifications for task updates. # The push notification configuration details.
+ "authentication": { # Defines authentication details, used for push notifications. # Information about the authentication to sent with the notification
+ "credentials": "A String", # Optional credentials
+ "schemes": [ # Supported authentication schemes - e.g. Basic, Bearer, etc
+ "A String",
+ ],
+ },
+ "id": "A String", # A unique identifier (e.g. UUID) for this push notification.
+ "token": "A String", # Token unique for this task/session
+ "url": "A String", # Url to send the notification too
+ },
+}
+
+ configId: string, Required. The ID for the new config.
+ tenant: string, Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "name": "A String", # The resource name of the config. Format: tasks/{task_id}/pushNotificationConfigs/{config_id}
+ "pushNotificationConfig": { # Configuration for setting up push notifications for task updates. # The push notification configuration details.
+ "authentication": { # Defines authentication details, used for push notifications. # Information about the authentication to sent with the notification
+ "credentials": "A String", # Optional credentials
+ "schemes": [ # Supported authentication schemes - e.g. Basic, Bearer, etc
+ "A String",
+ ],
+ },
+ "id": "A String", # A unique identifier (e.g. UUID) for this push notification.
+ "token": "A String", # Token unique for this task/session
+ "url": "A String", # Url to send the notification too
+ },
+}
+
+
+
+ delete(name, tenant=None, x__xgafv=None)
+ Delete a push notification config for a task.
+
+Args:
+ name: string, The resource name of the config to delete. Format: tasks/{task_id}/pushNotificationConfigs/{config_id} (required)
+ tenant: string, Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.
+ 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, tenant=None, x__xgafv=None)
+ Get a push notification config for a task.
+
+Args:
+ name: string, The resource name of the config to retrieve. Format: tasks/{task_id}/pushNotificationConfigs/{config_id} (required)
+ tenant: string, Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "name": "A String", # The resource name of the config. Format: tasks/{task_id}/pushNotificationConfigs/{config_id}
+ "pushNotificationConfig": { # Configuration for setting up push notifications for task updates. # The push notification configuration details.
+ "authentication": { # Defines authentication details, used for push notifications. # Information about the authentication to sent with the notification
+ "credentials": "A String", # Optional credentials
+ "schemes": [ # Supported authentication schemes - e.g. Basic, Bearer, etc
+ "A String",
+ ],
+ },
+ "id": "A String", # A unique identifier (e.g. UUID) for this push notification.
+ "token": "A String", # Token unique for this task/session
+ "url": "A String", # Url to send the notification too
+ },
+}
+
+
+
+ list(parent, pageSize=None, pageToken=None, tenant=None, x__xgafv=None)
+ Get a list of push notifications configured for a task.
+
+Args:
+ parent: string, The parent task resource. Format: tasks/{task_id} (required)
+ pageSize: integer, For AIP-158 these fields are present. Usually not used/needed. The maximum number of configurations to return. If unspecified, all configs will be returned.
+ pageToken: string, A page token received from a previous ListTaskPushNotificationConfigRequest call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTaskPushNotificationConfigRequest` must match the call that provided the page token.
+ tenant: string, Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "configs": [ # The list of push notification configurations.
+ {
+ "name": "A String", # The resource name of the config. Format: tasks/{task_id}/pushNotificationConfigs/{config_id}
+ "pushNotificationConfig": { # Configuration for setting up push notifications for task updates. # The push notification configuration details.
+ "authentication": { # Defines authentication details, used for push notifications. # Information about the authentication to sent with the notification
+ "credentials": "A String", # Optional credentials
+ "schemes": [ # Supported authentication schemes - e.g. Basic, Bearer, etc
+ "A String",
+ ],
+ },
+ "id": "A String", # A unique identifier (e.g. UUID) for this push notification.
+ "token": "A String", # Token unique for this task/session
+ "url": "A String", # Url to send the notification too
+ },
+ },
+ ],
+ "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+
+
+ list_next(previous_request, previous_response)
+ 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/cloudbilling_v1.v1.html b/docs/dyn/cloudbilling_v1.v1.html
new file mode 100644
index 0000000000..0928fe014f
--- /dev/null
+++ b/docs/dyn/cloudbilling_v1.v1.html
@@ -0,0 +1,253 @@
+
+
+
+Cloud Billing API . v1
+Instance Methods
+
+ close()
+Close httplib2 connections.
+
+ getCard(tenant=None, x__xgafv=None)
+GetAgentCard returns the agent card for the agent.
+Method Details
+
+ close()
+ Close httplib2 connections.
+
+
+
+ getCard(tenant=None, x__xgafv=None)
+ GetAgentCard returns the agent card for the agent.
+
+Args:
+ tenant: string, Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # AgentCard conveys key information: - Overall details (version, name, description, uses) - Skills; a set of actions/solutions the agent can perform - Default modalities/content types supported by the agent. - Authentication requirements Next ID: 19
+ "additionalInterfaces": [ # Announcement of additional supported transports. Client can use any of the supported transports.
+ { # Defines additional transport information for the agent.
+ "tenant": "A String", # Tenant to be set in the request when calling the agent. Experimental, might still change for 1.0 release.
+ "transport": "A String", # The transport supported this url. This is an open form string, to be easily extended for many transport protocols. The core ones officially supported are JSONRPC, GRPC and HTTP+JSON.
+ "url": "A String", # The url this interface is found at.
+ },
+ ],
+ "capabilities": { # Defines the A2A feature set supported by the agent # A2A Capability set supported by the agent.
+ "extensions": [ # Extensions supported by this agent.
+ { # A declaration of an extension supported by an Agent.
+ "description": "A String", # A description of how this agent uses this extension. Example: "Google OAuth 2.0 authentication"
+ "params": { # Optional configuration for the extension.
+ "a_key": "", # Properties of the object.
+ },
+ "required": True or False, # Whether the client must follow specific requirements of the extension. Example: false
+ "uri": "A String", # The URI of the extension. Example: "https://developers.google.com/identity/protocols/oauth2"
+ },
+ ],
+ "pushNotifications": True or False, # If the agent can send push notifications to the clients webhook
+ "streaming": True or False, # If the agent will support streaming responses
+ },
+ "defaultInputModes": [ # protolint:enable REPEATED_FIELD_NAMES_PLURALIZED The set of interaction modes that the agent supports across all skills. This can be overridden per skill. Defined as mime types.
+ "A String",
+ ],
+ "defaultOutputModes": [ # The mime types supported as outputs from this agent.
+ "A String",
+ ],
+ "description": "A String", # A description of the agent's domain of action/solution space. Example: "Agent that helps users with recipes and cooking."
+ "documentationUrl": "A String", # A url to provide additional documentation about the agent.
+ "iconUrl": "A String", # An optional URL to an icon for the agent.
+ "name": "A String", # A human readable name for the agent. Example: "Recipe Agent"
+ "preferredTransport": "A String", # The transport of the preferred endpoint. If empty, defaults to JSONRPC.
+ "protocolVersion": "A String", # The version of the A2A protocol this agent supports.
+ "provider": { # Represents information about the service provider of an agent. # The service provider of the agent.
+ "organization": "A String", # The providers organization name Example: "Google"
+ "url": "A String", # The providers reference url Example: "https://ai.google.dev"
+ },
+ "security": [ # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED Security requirements for contacting the agent. This list can be seen as an OR of ANDs. Each object in the list describes one possible set of security requirements that must be present on a request. This allows specifying, for example, "callers must either use OAuth OR an API Key AND mTLS." Example: security { schemes { key: "oauth" value { list: ["read"] } } } security { schemes { key: "api-key" } schemes { key: "mtls" } }
+ {
+ "schemes": {
+ "a_key": { # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED
+ "list": [
+ "A String",
+ ],
+ },
+ },
+ },
+ ],
+ "securitySchemes": { # The security scheme details used for authenticating with this agent.
+ "a_key": {
+ "apiKeySecurityScheme": {
+ "description": "A String", # Description of this security scheme.
+ "location": "A String", # Location of the API key, valid values are "query", "header", or "cookie"
+ "name": "A String", # Name of the header, query or cookie parameter to be used.
+ },
+ "httpAuthSecurityScheme": {
+ "bearerFormat": "A String", # A hint to the client to identify how the bearer token is formatted. Bearer tokens are usually generated by an authorization server, so this information is primarily for documentation purposes.
+ "description": "A String", # Description of this security scheme.
+ "scheme": "A String", # The name of the HTTP Authentication scheme to be used in the Authorization header as defined in RFC7235. The values used SHOULD be registered in the IANA Authentication Scheme registry. The value is case-insensitive, as defined in RFC7235.
+ },
+ "mtlsSecurityScheme": {
+ "description": "A String", # Description of this security scheme.
+ },
+ "oauth2SecurityScheme": {
+ "description": "A String", # Description of this security scheme.
+ "flows": { # An object containing configuration information for the flow types supported
+ "authorizationCode": {
+ "authorizationUrl": "A String", # The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS
+ "refreshUrl": "A String", # The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.
+ "scopes": { # The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty.
+ "a_key": "A String",
+ },
+ "tokenUrl": "A String", # The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.
+ },
+ "clientCredentials": {
+ "refreshUrl": "A String", # The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.
+ "scopes": { # The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty.
+ "a_key": "A String",
+ },
+ "tokenUrl": "A String", # The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.
+ },
+ "implicit": {
+ "authorizationUrl": "A String", # The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS
+ "refreshUrl": "A String", # The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.
+ "scopes": { # The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty.
+ "a_key": "A String",
+ },
+ },
+ "password": {
+ "refreshUrl": "A String", # The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.
+ "scopes": { # The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty.
+ "a_key": "A String",
+ },
+ "tokenUrl": "A String", # The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.
+ },
+ },
+ "oauth2MetadataUrl": "A String", # URL to the oauth2 authorization server metadata [RFC8414](https://datatracker.ietf.org/doc/html/rfc8414). TLS is required.
+ },
+ "openIdConnectSecurityScheme": {
+ "description": "A String", # Description of this security scheme.
+ "openIdConnectUrl": "A String", # Well-known URL to discover the [[OpenID-Connect-Discovery]] provider metadata.
+ },
+ },
+ },
+ "signatures": [ # JSON Web Signatures computed for this AgentCard.
+ { # AgentCardSignature represents a JWS signature of an AgentCard. This follows the JSON format of an RFC 7515 JSON Web Signature (JWS).
+ "header": { # The unprotected JWS header values.
+ "a_key": "", # Properties of the object.
+ },
+ "protected": "A String", # Required. The protected JWS header for the signature. This is always a base64url-encoded JSON object. Required.
+ "signature": "A String", # Required. The computed signature, base64url-encoded. Required.
+ },
+ ],
+ "skills": [ # Skills represent a unit of ability an agent can perform. This may somewhat abstract but represents a more focused set of actions that the agent is highly likely to succeed at.
+ { # AgentSkill represents a unit of action/solution that the agent can perform. One can think of this as a type of highly reliable solution that an agent can be tasked to provide. Agents have the autonomy to choose how and when to use specific skills, but clients should have confidence that if the skill is defined that unit of action can be reliably performed.
+ "description": "A String", # A human (or llm) readable description of the skill details and behaviors.
+ "examples": [ # A set of example queries that this skill is designed to address. These examples should help the caller to understand how to craft requests to the agent to achieve specific goals. Example: ["I need a recipe for bread"]
+ "A String",
+ ],
+ "id": "A String", # Unique identifier of the skill within this agent.
+ "inputModes": [ # Possible input modalities supported.
+ "A String",
+ ],
+ "name": "A String", # A human readable name for the skill.
+ "outputModes": [ # Possible output modalities produced
+ "A String",
+ ],
+ "security": [ # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED Security schemes necessary for the agent to leverage this skill. As in the overall AgentCard.security, this list represents a logical OR of security requirement objects. Each object is a set of security schemes that must be used together (a logical AND). protolint:enable REPEATED_FIELD_NAMES_PLURALIZED
+ {
+ "schemes": {
+ "a_key": { # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED
+ "list": [
+ "A String",
+ ],
+ },
+ },
+ },
+ ],
+ "tags": [ # A set of tags for the skill to enhance categorization/utilization. Example: ["cooking", "customer support", "billing"]
+ "A String",
+ ],
+ },
+ ],
+ "supportsAuthenticatedExtendedCard": True or False, # Whether the agent supports providing an extended agent card when the user is authenticated, i.e. is the card from .well-known different than the card from GetAgentCard.
+ "url": "A String", # A URL to the address the agent is hosted at. This represents the preferred endpoint as declared by the agent.
+ "version": "A String", # The version of the agent. Example: "1.0.0"
+}
+
+
+
\ No newline at end of file
diff --git a/googleapiclient/discovery_cache/documents/cloudbilling.v1.json b/googleapiclient/discovery_cache/documents/cloudbilling.v1.json
index 58959ceae9..627c56fabc 100644
--- a/googleapiclient/discovery_cache/documents/cloudbilling.v1.json
+++ b/googleapiclient/discovery_cache/documents/cloudbilling.v1.json
@@ -482,6 +482,50 @@
}
}
},
+"message": {
+"methods": {
+"send": {
+"description": "Send a message to the agent. This is a blocking call that will return the task once it is completed, or a LRO if requested.",
+"flatPath": "v1/message:send",
+"httpMethod": "POST",
+"id": "cloudbilling.message.send",
+"parameterOrder": [],
+"parameters": {},
+"path": "v1/message:send",
+"request": {
+"$ref": "SendMessageRequest"
+},
+"response": {
+"$ref": "SendMessageResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-billing",
+"https://www.googleapis.com/auth/cloud-billing.readonly",
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"stream": {
+"description": "SendStreamingMessage is a streaming call that will return a stream of task update events until the Task is in an interrupted or terminal state.",
+"flatPath": "v1/message:stream",
+"httpMethod": "POST",
+"id": "cloudbilling.message.stream",
+"parameterOrder": [],
+"parameters": {},
+"path": "v1/message:stream",
+"request": {
+"$ref": "SendMessageRequest"
+},
+"response": {
+"$ref": "StreamResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-billing",
+"https://www.googleapis.com/auth/cloud-billing.readonly",
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+},
"organizations": {
"resources": {
"billingAccounts": {
@@ -749,11 +793,573 @@
}
}
}
+},
+"tasks": {
+"methods": {
+"cancel": {
+"description": "Cancel a task from the agent. If supported one should expect no more task updates for the task.",
+"flatPath": "v1/tasks/{tasksId}:cancel",
+"httpMethod": "POST",
+"id": "cloudbilling.tasks.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The resource name of the task to cancel. Format: tasks/{task_id}",
+"location": "path",
+"pattern": "^tasks/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}:cancel",
+"request": {
+"$ref": "CancelTaskRequest"
+},
+"response": {
+"$ref": "Task"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-billing",
+"https://www.googleapis.com/auth/cloud-billing.readonly",
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Get the current state of a task from the agent.",
+"flatPath": "v1/tasks/{tasksId}",
+"httpMethod": "GET",
+"id": "cloudbilling.tasks.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"historyLength": {
+"description": "The number of most recent messages from the task's history to retrieve.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"name": {
+"description": "Required. The resource name of the task. Format: tasks/{task_id}",
+"location": "path",
+"pattern": "^tasks/[^/]+$",
+"required": true,
+"type": "string"
+},
+"tenant": {
+"description": "Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "Task"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-billing",
+"https://www.googleapis.com/auth/cloud-billing.readonly",
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"subscribe": {
+"description": "TaskSubscription is a streaming call that will return a stream of task update events. This attaches the stream to an existing in process task. If the task is complete the stream will return the completed task (like GetTask) and close the stream.",
+"flatPath": "v1/tasks/{tasksId}:subscribe",
+"httpMethod": "GET",
+"id": "cloudbilling.tasks.subscribe",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The resource name of the task to subscribe to. Format: tasks/{task_id}",
+"location": "path",
+"pattern": "^tasks/[^/]+$",
+"required": true,
+"type": "string"
+},
+"tenant": {
+"description": "Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}:subscribe",
+"response": {
+"$ref": "StreamResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-billing",
+"https://www.googleapis.com/auth/cloud-billing.readonly",
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+},
+"resources": {
+"pushNotificationConfigs": {
+"methods": {
+"create": {
+"description": "Set a push notification config for a task.",
+"flatPath": "v1/tasks/{tasksId}/pushNotificationConfigs",
+"httpMethod": "POST",
+"id": "cloudbilling.tasks.pushNotificationConfigs.create",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"configId": {
+"description": "Required. The ID for the new config.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The parent task resource for this config. Format: tasks/{task_id}",
+"location": "path",
+"pattern": "^tasks/[^/]+/pushNotificationConfigs$",
+"required": true,
+"type": "string"
+},
+"tenant": {
+"description": "Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+parent}",
+"request": {
+"$ref": "TaskPushNotificationConfig"
+},
+"response": {
+"$ref": "TaskPushNotificationConfig"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-billing",
+"https://www.googleapis.com/auth/cloud-billing.readonly",
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Delete a push notification config for a task.",
+"flatPath": "v1/tasks/{tasksId}/pushNotificationConfigs/{pushNotificationConfigsId}",
+"httpMethod": "DELETE",
+"id": "cloudbilling.tasks.pushNotificationConfigs.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The resource name of the config to delete. Format: tasks/{task_id}/pushNotificationConfigs/{config_id}",
+"location": "path",
+"pattern": "^tasks/[^/]+/pushNotificationConfigs/[^/]+$",
+"required": true,
+"type": "string"
+},
+"tenant": {
+"description": "Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "Empty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-billing",
+"https://www.googleapis.com/auth/cloud-billing.readonly",
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Get a push notification config for a task.",
+"flatPath": "v1/tasks/{tasksId}/pushNotificationConfigs/{pushNotificationConfigsId}",
+"httpMethod": "GET",
+"id": "cloudbilling.tasks.pushNotificationConfigs.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The resource name of the config to retrieve. Format: tasks/{task_id}/pushNotificationConfigs/{config_id}",
+"location": "path",
+"pattern": "^tasks/[^/]+/pushNotificationConfigs/[^/]+$",
+"required": true,
+"type": "string"
+},
+"tenant": {
+"description": "Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "TaskPushNotificationConfig"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-billing",
+"https://www.googleapis.com/auth/cloud-billing.readonly",
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Get a list of push notifications configured for a task.",
+"flatPath": "v1/tasks/{tasksId}/pushNotificationConfigs",
+"httpMethod": "GET",
+"id": "cloudbilling.tasks.pushNotificationConfigs.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"pageSize": {
+"description": "For AIP-158 these fields are present. Usually not used/needed. The maximum number of configurations to return. If unspecified, all configs will be returned.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "A page token received from a previous ListTaskPushNotificationConfigRequest call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTaskPushNotificationConfigRequest` must match the call that provided the page token.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "The parent task resource. Format: tasks/{task_id}",
+"location": "path",
+"pattern": "^tasks/[^/]+$",
+"required": true,
+"type": "string"
+},
+"tenant": {
+"description": "Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+parent}/pushNotificationConfigs",
+"response": {
+"$ref": "ListTaskPushNotificationConfigResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-billing",
+"https://www.googleapis.com/auth/cloud-billing.readonly",
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+},
+"v1": {
+"methods": {
+"getCard": {
+"description": "GetAgentCard returns the agent card for the agent.",
+"flatPath": "v1/card",
+"httpMethod": "GET",
+"id": "cloudbilling.getCard",
+"parameterOrder": [],
+"parameters": {
+"tenant": {
+"description": "Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/card",
+"response": {
+"$ref": "AgentCard"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-billing",
+"https://www.googleapis.com/auth/cloud-billing.readonly",
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
}
},
-"revision": "20241011",
+"revision": "20260901",
"rootUrl": "https://cloudbilling.googleapis.com/",
"schemas": {
+"APIKeySecurityScheme": {
+"id": "APIKeySecurityScheme",
+"properties": {
+"description": {
+"description": "Description of this security scheme.",
+"type": "string"
+},
+"location": {
+"description": "Location of the API key, valid values are \"query\", \"header\", or \"cookie\"",
+"type": "string"
+},
+"name": {
+"description": "Name of the header, query or cookie parameter to be used.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"AgentCapabilities": {
+"description": "Defines the A2A feature set supported by the agent",
+"id": "AgentCapabilities",
+"properties": {
+"extensions": {
+"description": "Extensions supported by this agent.",
+"items": {
+"$ref": "AgentExtension"
+},
+"type": "array"
+},
+"pushNotifications": {
+"description": "If the agent can send push notifications to the clients webhook",
+"type": "boolean"
+},
+"streaming": {
+"description": "If the agent will support streaming responses",
+"type": "boolean"
+}
+},
+"type": "object"
+},
+"AgentCard": {
+"description": "AgentCard conveys key information: - Overall details (version, name, description, uses) - Skills; a set of actions/solutions the agent can perform - Default modalities/content types supported by the agent. - Authentication requirements Next ID: 19",
+"id": "AgentCard",
+"properties": {
+"additionalInterfaces": {
+"description": "Announcement of additional supported transports. Client can use any of the supported transports.",
+"items": {
+"$ref": "AgentInterface"
+},
+"type": "array"
+},
+"capabilities": {
+"$ref": "AgentCapabilities",
+"description": "A2A Capability set supported by the agent."
+},
+"defaultInputModes": {
+"description": "protolint:enable REPEATED_FIELD_NAMES_PLURALIZED The set of interaction modes that the agent supports across all skills. This can be overridden per skill. Defined as mime types.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
+"defaultOutputModes": {
+"description": "The mime types supported as outputs from this agent.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
+"description": {
+"description": "A description of the agent's domain of action/solution space. Example: \"Agent that helps users with recipes and cooking.\"",
+"type": "string"
+},
+"documentationUrl": {
+"description": "A url to provide additional documentation about the agent.",
+"type": "string"
+},
+"iconUrl": {
+"description": "An optional URL to an icon for the agent.",
+"type": "string"
+},
+"name": {
+"description": "A human readable name for the agent. Example: \"Recipe Agent\"",
+"type": "string"
+},
+"preferredTransport": {
+"description": "The transport of the preferred endpoint. If empty, defaults to JSONRPC.",
+"type": "string"
+},
+"protocolVersion": {
+"description": "The version of the A2A protocol this agent supports.",
+"type": "string"
+},
+"provider": {
+"$ref": "AgentProvider",
+"description": "The service provider of the agent."
+},
+"security": {
+"description": "protolint:disable REPEATED_FIELD_NAMES_PLURALIZED Security requirements for contacting the agent. This list can be seen as an OR of ANDs. Each object in the list describes one possible set of security requirements that must be present on a request. This allows specifying, for example, \"callers must either use OAuth OR an API Key AND mTLS.\" Example: security { schemes { key: \"oauth\" value { list: [\"read\"] } } } security { schemes { key: \"api-key\" } schemes { key: \"mtls\" } }",
+"items": {
+"$ref": "Security"
+},
+"type": "array"
+},
+"securitySchemes": {
+"additionalProperties": {
+"$ref": "SecurityScheme"
+},
+"description": "The security scheme details used for authenticating with this agent.",
+"type": "object"
+},
+"signatures": {
+"description": "JSON Web Signatures computed for this AgentCard.",
+"items": {
+"$ref": "AgentCardSignature"
+},
+"type": "array"
+},
+"skills": {
+"description": "Skills represent a unit of ability an agent can perform. This may somewhat abstract but represents a more focused set of actions that the agent is highly likely to succeed at.",
+"items": {
+"$ref": "AgentSkill"
+},
+"type": "array"
+},
+"supportsAuthenticatedExtendedCard": {
+"description": "Whether the agent supports providing an extended agent card when the user is authenticated, i.e. is the card from .well-known different than the card from GetAgentCard.",
+"type": "boolean"
+},
+"url": {
+"description": "A URL to the address the agent is hosted at. This represents the preferred endpoint as declared by the agent.",
+"type": "string"
+},
+"version": {
+"description": "The version of the agent. Example: \"1.0.0\"",
+"type": "string"
+}
+},
+"type": "object"
+},
+"AgentCardSignature": {
+"description": "AgentCardSignature represents a JWS signature of an AgentCard. This follows the JSON format of an RFC 7515 JSON Web Signature (JWS).",
+"id": "AgentCardSignature",
+"properties": {
+"header": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "The unprotected JWS header values.",
+"type": "object"
+},
+"protected": {
+"description": "Required. The protected JWS header for the signature. This is always a base64url-encoded JSON object. Required.",
+"type": "string"
+},
+"signature": {
+"description": "Required. The computed signature, base64url-encoded. Required.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"AgentExtension": {
+"description": "A declaration of an extension supported by an Agent.",
+"id": "AgentExtension",
+"properties": {
+"description": {
+"description": "A description of how this agent uses this extension. Example: \"Google OAuth 2.0 authentication\"",
+"type": "string"
+},
+"params": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "Optional configuration for the extension.",
+"type": "object"
+},
+"required": {
+"description": "Whether the client must follow specific requirements of the extension. Example: false",
+"type": "boolean"
+},
+"uri": {
+"description": "The URI of the extension. Example: \"https://developers.google.com/identity/protocols/oauth2\"",
+"type": "string"
+}
+},
+"type": "object"
+},
+"AgentInterface": {
+"description": "Defines additional transport information for the agent.",
+"id": "AgentInterface",
+"properties": {
+"tenant": {
+"description": "Tenant to be set in the request when calling the agent. Experimental, might still change for 1.0 release.",
+"type": "string"
+},
+"transport": {
+"description": "The transport supported this url. This is an open form string, to be easily extended for many transport protocols. The core ones officially supported are JSONRPC, GRPC and HTTP+JSON.",
+"type": "string"
+},
+"url": {
+"description": "The url this interface is found at.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"AgentProvider": {
+"description": "Represents information about the service provider of an agent.",
+"id": "AgentProvider",
+"properties": {
+"organization": {
+"description": "The providers organization name Example: \"Google\"",
+"type": "string"
+},
+"url": {
+"description": "The providers reference url Example: \"https://ai.google.dev\"",
+"type": "string"
+}
+},
+"type": "object"
+},
+"AgentSkill": {
+"description": "AgentSkill represents a unit of action/solution that the agent can perform. One can think of this as a type of highly reliable solution that an agent can be tasked to provide. Agents have the autonomy to choose how and when to use specific skills, but clients should have confidence that if the skill is defined that unit of action can be reliably performed.",
+"id": "AgentSkill",
+"properties": {
+"description": {
+"description": "A human (or llm) readable description of the skill details and behaviors.",
+"type": "string"
+},
+"examples": {
+"description": "A set of example queries that this skill is designed to address. These examples should help the caller to understand how to craft requests to the agent to achieve specific goals. Example: [\"I need a recipe for bread\"]",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
+"id": {
+"description": "Unique identifier of the skill within this agent.",
+"type": "string"
+},
+"inputModes": {
+"description": "Possible input modalities supported.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
+"name": {
+"description": "A human readable name for the skill.",
+"type": "string"
+},
+"outputModes": {
+"description": "Possible output modalities produced",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
+"security": {
+"description": "protolint:disable REPEATED_FIELD_NAMES_PLURALIZED Security schemes necessary for the agent to leverage this skill. As in the overall AgentCard.security, this list represents a logical OR of security requirement objects. Each object is a set of security schemes that must be used together (a logical AND). protolint:enable REPEATED_FIELD_NAMES_PLURALIZED",
+"items": {
+"$ref": "Security"
+},
+"type": "array"
+},
+"tags": {
+"description": "A set of tags for the skill to enhance categorization/utilization. Example: [\"cooking\", \"customer support\", \"billing\"]",
+"items": {
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
"AggregationInfo": {
"description": "Represents the aggregation level and interval for pricing of a single SKU.",
"id": "AggregationInfo",
@@ -792,6 +1398,47 @@
},
"type": "object"
},
+"Artifact": {
+"description": "Artifacts are the container for task completed results. These are similar to Messages but are intended to be the product of a task, as opposed to point-to-point communication.",
+"id": "Artifact",
+"properties": {
+"artifactId": {
+"description": "Unique identifier (e.g. UUID) for the artifact. It must be at least unique within a task.",
+"type": "string"
+},
+"description": {
+"description": "A human readable description of the artifact, optional.",
+"type": "string"
+},
+"extensions": {
+"description": "The URIs of extensions that are present or contributed to this Artifact.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
+"metadata": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "Optional metadata included with the artifact.",
+"type": "object"
+},
+"name": {
+"description": "A human readable name for the artifact.",
+"type": "string"
+},
+"parts": {
+"description": "The content of the artifact.",
+"items": {
+"$ref": "Part"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
"AuditConfig": {
"description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.",
"id": "AuditConfig",
@@ -840,6 +1487,49 @@
},
"type": "object"
},
+"AuthenticationInfo": {
+"description": "Defines authentication details, used for push notifications.",
+"id": "AuthenticationInfo",
+"properties": {
+"credentials": {
+"description": "Optional credentials",
+"type": "string"
+},
+"schemes": {
+"description": "Supported authentication schemes - e.g. Basic, Bearer, etc",
+"items": {
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"AuthorizationCodeOAuthFlow": {
+"id": "AuthorizationCodeOAuthFlow",
+"properties": {
+"authorizationUrl": {
+"description": "The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS",
+"type": "string"
+},
+"refreshUrl": {
+"description": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.",
+"type": "string"
+},
+"scopes": {
+"additionalProperties": {
+"type": "string"
+},
+"description": "The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty.",
+"type": "object"
+},
+"tokenUrl": {
+"description": "The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.",
+"type": "string"
+}
+},
+"type": "object"
+},
"BillingAccount": {
"description": "A billing account in the [Google Cloud Console](https://console.cloud.google.com/). You can assign a billing account to one or more projects.",
"id": "BillingAccount",
@@ -896,6 +1586,16 @@
},
"type": "object"
},
+"CancelTaskRequest": {
+"id": "CancelTaskRequest",
+"properties": {
+"tenant": {
+"description": "Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.",
+"type": "string"
+}
+},
+"type": "object"
+},
"Category": {
"description": "Represents the category hierarchy of a SKU.",
"id": "Category",
@@ -919,6 +1619,47 @@
},
"type": "object"
},
+"ClientCredentialsOAuthFlow": {
+"id": "ClientCredentialsOAuthFlow",
+"properties": {
+"refreshUrl": {
+"description": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.",
+"type": "string"
+},
+"scopes": {
+"additionalProperties": {
+"type": "string"
+},
+"description": "The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty.",
+"type": "object"
+},
+"tokenUrl": {
+"description": "The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"DataPart": {
+"description": "DataPart represents a structured blob. This is most commonly a JSON payload.",
+"id": "DataPart",
+"properties": {
+"data": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"type": "object"
+}
+},
+"type": "object"
+},
+"Empty": {
+"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }",
+"id": "Empty",
+"properties": {},
+"type": "object"
+},
"Expr": {
"description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.",
"id": "Expr",
@@ -942,6 +1683,26 @@
},
"type": "object"
},
+"FilePart": {
+"description": "FilePart represents the different ways files can be provided. If files are small, directly feeding the bytes is supported via file_with_bytes. If the file is large, the agent should read the content as appropriate directly from the file_with_uri source.",
+"id": "FilePart",
+"properties": {
+"fileWithBytes": {
+"format": "byte",
+"type": "string"
+},
+"fileWithUri": {
+"type": "string"
+},
+"mimeType": {
+"type": "string"
+},
+"name": {
+"type": "string"
+}
+},
+"type": "object"
+},
"GeoTaxonomy": {
"description": "Encapsulates the geographic taxonomy data for a sku.",
"id": "GeoTaxonomy",
@@ -972,6 +1733,45 @@
},
"type": "object"
},
+"HTTPAuthSecurityScheme": {
+"id": "HTTPAuthSecurityScheme",
+"properties": {
+"bearerFormat": {
+"description": "A hint to the client to identify how the bearer token is formatted. Bearer tokens are usually generated by an authorization server, so this information is primarily for documentation purposes.",
+"type": "string"
+},
+"description": {
+"description": "Description of this security scheme.",
+"type": "string"
+},
+"scheme": {
+"description": "The name of the HTTP Authentication scheme to be used in the Authorization header as defined in RFC7235. The values used SHOULD be registered in the IANA Authentication Scheme registry. The value is case-insensitive, as defined in RFC7235.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"ImplicitOAuthFlow": {
+"id": "ImplicitOAuthFlow",
+"properties": {
+"authorizationUrl": {
+"description": "The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS",
+"type": "string"
+},
+"refreshUrl": {
+"description": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.",
+"type": "string"
+},
+"scopes": {
+"additionalProperties": {
+"type": "string"
+},
+"description": "The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty.",
+"type": "object"
+}
+},
+"type": "object"
+},
"ListBillingAccountsResponse": {
"description": "Response message for `ListBillingAccounts`.",
"id": "ListBillingAccountsResponse",
@@ -1044,6 +1844,78 @@
},
"type": "object"
},
+"ListTaskPushNotificationConfigResponse": {
+"id": "ListTaskPushNotificationConfigResponse",
+"properties": {
+"configs": {
+"description": "The list of push notification configurations.",
+"items": {
+"$ref": "TaskPushNotificationConfig"
+},
+"type": "array"
+},
+"nextPageToken": {
+"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"Message": {
+"description": "Message is one unit of communication between client and server. It is associated with a context and optionally a task. Since the server is responsible for the context definition, it must always provide a context_id in its messages. The client can optionally provide the context_id if it knows the context to associate the message to. Similarly for task_id, except the server decides if a task is created and whether to include the task_id.",
+"id": "Message",
+"properties": {
+"content": {
+"description": "protolint:disable REPEATED_FIELD_NAMES_PLURALIZED Content is the container of the message content.",
+"items": {
+"$ref": "Part"
+},
+"type": "array"
+},
+"contextId": {
+"description": "The context id of the message. This is optional and if set, the message will be associated with the given context.",
+"type": "string"
+},
+"extensions": {
+"description": "The URIs of extensions that are present or contributed to this Message.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
+"messageId": {
+"description": "The unique identifier (e.g. UUID)of the message. This is required and created by the message creator.",
+"type": "string"
+},
+"metadata": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "protolint:enable REPEATED_FIELD_NAMES_PLURALIZED Any optional metadata to provide along with the message.",
+"type": "object"
+},
+"role": {
+"description": "A role for the message.",
+"enum": [
+"ROLE_UNSPECIFIED",
+"ROLE_USER",
+"ROLE_AGENT"
+],
+"enumDescriptions": [
+"",
+"USER role refers to communication from the client to the server.",
+"AGENT role refers to communication from the server to the client."
+],
+"type": "string"
+},
+"taskId": {
+"description": "The task id of the message. This is optional and if set, the message will be associated with the given task.",
+"type": "string"
+}
+},
+"type": "object"
+},
"Money": {
"description": "Represents an amount of money with its currency type.",
"id": "Money",
@@ -1076,6 +1948,111 @@
},
"type": "object"
},
+"MutualTlsSecurityScheme": {
+"id": "MutualTlsSecurityScheme",
+"properties": {
+"description": {
+"description": "Description of this security scheme.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"OAuth2SecurityScheme": {
+"id": "OAuth2SecurityScheme",
+"properties": {
+"description": {
+"description": "Description of this security scheme.",
+"type": "string"
+},
+"flows": {
+"$ref": "OAuthFlows",
+"description": "An object containing configuration information for the flow types supported"
+},
+"oauth2MetadataUrl": {
+"description": "URL to the oauth2 authorization server metadata [RFC8414](https://datatracker.ietf.org/doc/html/rfc8414). TLS is required.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"OAuthFlows": {
+"id": "OAuthFlows",
+"properties": {
+"authorizationCode": {
+"$ref": "AuthorizationCodeOAuthFlow"
+},
+"clientCredentials": {
+"$ref": "ClientCredentialsOAuthFlow"
+},
+"implicit": {
+"$ref": "ImplicitOAuthFlow"
+},
+"password": {
+"$ref": "PasswordOAuthFlow"
+}
+},
+"type": "object"
+},
+"OpenIdConnectSecurityScheme": {
+"id": "OpenIdConnectSecurityScheme",
+"properties": {
+"description": {
+"description": "Description of this security scheme.",
+"type": "string"
+},
+"openIdConnectUrl": {
+"description": "Well-known URL to discover the [[OpenID-Connect-Discovery]] provider metadata.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"Part": {
+"description": "Part represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON).",
+"id": "Part",
+"properties": {
+"data": {
+"$ref": "DataPart"
+},
+"file": {
+"$ref": "FilePart"
+},
+"metadata": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "Optional metadata associated with this part.",
+"type": "object"
+},
+"text": {
+"type": "string"
+}
+},
+"type": "object"
+},
+"PasswordOAuthFlow": {
+"id": "PasswordOAuthFlow",
+"properties": {
+"refreshUrl": {
+"description": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.",
+"type": "string"
+},
+"scopes": {
+"additionalProperties": {
+"type": "string"
+},
+"description": "The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty.",
+"type": "object"
+},
+"tokenUrl": {
+"description": "The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.",
+"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",
@@ -1202,6 +2179,129 @@
},
"type": "object"
},
+"PushNotificationConfig": {
+"description": "Configuration for setting up push notifications for task updates.",
+"id": "PushNotificationConfig",
+"properties": {
+"authentication": {
+"$ref": "AuthenticationInfo",
+"description": "Information about the authentication to sent with the notification"
+},
+"id": {
+"description": "A unique identifier (e.g. UUID) for this push notification.",
+"type": "string"
+},
+"token": {
+"description": "Token unique for this task/session",
+"type": "string"
+},
+"url": {
+"description": "Url to send the notification too",
+"type": "string"
+}
+},
+"type": "object"
+},
+"Security": {
+"id": "Security",
+"properties": {
+"schemes": {
+"additionalProperties": {
+"$ref": "StringList"
+},
+"type": "object"
+}
+},
+"type": "object"
+},
+"SecurityScheme": {
+"id": "SecurityScheme",
+"properties": {
+"apiKeySecurityScheme": {
+"$ref": "APIKeySecurityScheme"
+},
+"httpAuthSecurityScheme": {
+"$ref": "HTTPAuthSecurityScheme"
+},
+"mtlsSecurityScheme": {
+"$ref": "MutualTlsSecurityScheme"
+},
+"oauth2SecurityScheme": {
+"$ref": "OAuth2SecurityScheme"
+},
+"openIdConnectSecurityScheme": {
+"$ref": "OpenIdConnectSecurityScheme"
+}
+},
+"type": "object"
+},
+"SendMessageConfiguration": {
+"description": "Configuration of a send message request.",
+"id": "SendMessageConfiguration",
+"properties": {
+"acceptedOutputModes": {
+"description": "The output modes that the agent is expected to respond with.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
+"blocking": {
+"description": "If true, the message will be blocking until the task is completed. If false, the message will be non-blocking and the task will be returned immediately. It is the caller's responsibility to check for any task updates.",
+"type": "boolean"
+},
+"historyLength": {
+"description": "The maximum number of messages to include in the history. if 0, the history will be unlimited.",
+"format": "int32",
+"type": "integer"
+},
+"pushNotification": {
+"$ref": "PushNotificationConfig",
+"description": "A configuration of a webhook that can be used to receive updates"
+}
+},
+"type": "object"
+},
+"SendMessageRequest": {
+"description": "/////////// Request Messages ///////////",
+"id": "SendMessageRequest",
+"properties": {
+"configuration": {
+"$ref": "SendMessageConfiguration",
+"description": "Configuration for the send request."
+},
+"message": {
+"$ref": "Message",
+"description": "Required. The message to send to the agent."
+},
+"metadata": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "Optional metadata for the request.",
+"type": "object"
+},
+"tenant": {
+"description": "Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"SendMessageResponse": {
+"description": "////// Response Messages ///////////",
+"id": "SendMessageResponse",
+"properties": {
+"message": {
+"$ref": "Message"
+},
+"task": {
+"$ref": "Task"
+}
+},
+"type": "object"
+},
"Service": {
"description": "Encapsulates a single service in Google Cloud Platform.",
"id": "Service",
@@ -1286,6 +2386,201 @@
},
"type": "object"
},
+"StreamResponse": {
+"description": "The stream response for a message. The stream should be one of the following sequences: If the response is a message, the stream should contain one, and only one, message and then close If the response is a task lifecycle, the first response should be a Task object followed by zero or more TaskStatusUpdateEvents and TaskArtifactUpdateEvents. The stream should complete when the Task if in an interrupted or terminal state. A stream that ends before these conditions are met are",
+"id": "StreamResponse",
+"properties": {
+"artifactUpdate": {
+"$ref": "TaskArtifactUpdateEvent"
+},
+"message": {
+"$ref": "Message"
+},
+"statusUpdate": {
+"$ref": "TaskStatusUpdateEvent"
+},
+"task": {
+"$ref": "Task"
+}
+},
+"type": "object"
+},
+"StringList": {
+"description": "protolint:disable REPEATED_FIELD_NAMES_PLURALIZED",
+"id": "StringList",
+"properties": {
+"list": {
+"items": {
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"Task": {
+"description": "Task is the core unit of action for A2A. It has a current status and when results are created for the task they are stored in the artifact. If there are multiple turns for a task, these are stored in history.",
+"id": "Task",
+"properties": {
+"artifacts": {
+"description": "A set of output artifacts for a Task.",
+"items": {
+"$ref": "Artifact"
+},
+"type": "array"
+},
+"contextId": {
+"description": "Unique identifier (e.g. UUID) for the contextual collection of interactions (tasks and messages). Created by the A2A server.",
+"type": "string"
+},
+"history": {
+"description": "protolint:disable REPEATED_FIELD_NAMES_PLURALIZED The history of interactions from a task.",
+"items": {
+"$ref": "Message"
+},
+"type": "array"
+},
+"id": {
+"description": "Unique identifier (e.g. UUID) for the task, generated by the server for a new task.",
+"type": "string"
+},
+"metadata": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "protolint:enable REPEATED_FIELD_NAMES_PLURALIZED A key/value object to store custom metadata about a task.",
+"type": "object"
+},
+"status": {
+"$ref": "TaskStatus",
+"description": "The current status of a Task, including state and a message."
+}
+},
+"type": "object"
+},
+"TaskArtifactUpdateEvent": {
+"description": "TaskArtifactUpdateEvent represents a task delta where an artifact has been generated.",
+"id": "TaskArtifactUpdateEvent",
+"properties": {
+"append": {
+"description": "Whether this should be appended to a prior one produced",
+"type": "boolean"
+},
+"artifact": {
+"$ref": "Artifact",
+"description": "The artifact itself"
+},
+"contextId": {
+"description": "The id of the context that this task belongs too",
+"type": "string"
+},
+"lastChunk": {
+"description": "Whether this represents the last part of an artifact",
+"type": "boolean"
+},
+"metadata": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "Optional metadata associated with the artifact update.",
+"type": "object"
+},
+"taskId": {
+"description": "The id of the task for this artifact",
+"type": "string"
+}
+},
+"type": "object"
+},
+"TaskPushNotificationConfig": {
+"id": "TaskPushNotificationConfig",
+"properties": {
+"name": {
+"description": "The resource name of the config. Format: tasks/{task_id}/pushNotificationConfigs/{config_id}",
+"type": "string"
+},
+"pushNotificationConfig": {
+"$ref": "PushNotificationConfig",
+"description": "The push notification configuration details."
+}
+},
+"type": "object"
+},
+"TaskStatus": {
+"description": "A container for the status of a task",
+"id": "TaskStatus",
+"properties": {
+"message": {
+"$ref": "Message",
+"description": "A message associated with the status."
+},
+"state": {
+"description": "The current state of this task",
+"enum": [
+"TASK_STATE_UNSPECIFIED",
+"TASK_STATE_SUBMITTED",
+"TASK_STATE_WORKING",
+"TASK_STATE_COMPLETED",
+"TASK_STATE_FAILED",
+"TASK_STATE_CANCELLED",
+"TASK_STATE_INPUT_REQUIRED",
+"TASK_STATE_REJECTED",
+"TASK_STATE_AUTH_REQUIRED"
+],
+"enumDescriptions": [
+"",
+"Represents the status that acknowledges a task is created",
+"Represents the status that a task is actively being processed",
+"Represents the status a task is finished. This is a terminal state",
+"Represents the status a task is done but failed. This is a terminal state",
+"Represents the status a task was cancelled before it finished. This is a terminal state.",
+"Represents the status that the task requires information to complete. This is an interrupted state.",
+"Represents the status that the agent has decided to not perform the task. This may be done during initial task creation or later once an agent has determined it can't or won't proceed. This is a terminal state.",
+"Represents the state that some authentication is needed from the upstream client. Authentication is expected to come out-of-band thus this is not an interrupted or terminal state."
+],
+"type": "string"
+},
+"timestamp": {
+"description": "Timestamp when the status was recorded. Example: \"2023-10-27T10:00:00Z\"",
+"format": "google-datetime",
+"type": "string"
+}
+},
+"type": "object"
+},
+"TaskStatusUpdateEvent": {
+"description": "TaskStatusUpdateEvent is a delta even on a task indicating that a task has changed.",
+"id": "TaskStatusUpdateEvent",
+"properties": {
+"contextId": {
+"description": "The id of the context that the task belongs to",
+"type": "string"
+},
+"final": {
+"description": "Whether this is the last status update expected for this task.",
+"type": "boolean"
+},
+"metadata": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "Optional metadata to associate with the task update.",
+"type": "object"
+},
+"status": {
+"$ref": "TaskStatus",
+"description": "The new status of the task."
+},
+"taskId": {
+"description": "The id of the task that is changed",
+"type": "string"
+}
+},
+"type": "object"
+},
"TestIamPermissionsRequest": {
"description": "Request message for `TestIamPermissions` method.",
"id": "TestIamPermissionsRequest",
From 98885085fd85bf4b2770819b20a3855ba6913266 Mon Sep 17 00:00:00 2001
From: Yoshi Automation
Date: Tue, 8 Sep 2026 07:20:12 +0000
Subject: [PATCH 12/40] feat(cloudnumberregistry): update the api
#### cloudnumberregistry:v1alpha
The following keys were added:
- schemas.RegistryBook.properties.claimedScopesInfo (Total Keys: 3)
- schemas.ScopeInfo (Total Keys: 8)
---
...lpha.projects.locations.registryBooks.html | 30 +++++++++++++++-
.../cloudnumberregistry.v1alpha.json | 34 +++++++++++++++++--
2 files changed, 61 insertions(+), 3 deletions(-)
diff --git a/docs/dyn/cloudnumberregistry_v1alpha.projects.locations.registryBooks.html b/docs/dyn/cloudnumberregistry_v1alpha.projects.locations.registryBooks.html
index 0029c041d3..0ef75b2d1f 100644
--- a/docs/dyn/cloudnumberregistry_v1alpha.projects.locations.registryBooks.html
+++ b/docs/dyn/cloudnumberregistry_v1alpha.projects.locations.registryBooks.html
@@ -127,6 +127,13 @@ Method Details
"claimedScopes": [ # Optional. List of scopes claimed by the RegistryBook. In Preview, Only project scope is supported. Each scope is in the format of projects/{project}. Each scope can only be claimed once.
"A String",
],
+ "claimedScopesInfo": [ # Output only. Detailed scope information corresponding to each entry in `claimed_scopes`.
+ { # Details of a scope (e.g. project or folder).
+ "displayName": "A String", # Output only. Human-readable display title of the scope shown in Console (e.g. "My Cloud Project"). Used for UI display.
+ "id": "A String", # Output only. Programmatic string identifier of the scope (e.g. GCP Project ID "my-project-id"). Used for API and code logic.
+ "name": "A String", # Output only. Resource name of the scope, e.g. "projects/1234567890".
+ },
+ ],
"createTime": "A String", # Output only. The time at which the RegistryBook was created.
"isDefault": True or False, # Output only. Whether the RegistryBook is the default one.
"labels": { # Optional. User-defined labels.
@@ -235,6 +242,13 @@ Method Details
"claimedScopes": [ # Optional. List of scopes claimed by the RegistryBook. In Preview, Only project scope is supported. Each scope is in the format of projects/{project}. Each scope can only be claimed once.
"A String",
],
+ "claimedScopesInfo": [ # Output only. Detailed scope information corresponding to each entry in `claimed_scopes`.
+ { # Details of a scope (e.g. project or folder).
+ "displayName": "A String", # Output only. Human-readable display title of the scope shown in Console (e.g. "My Cloud Project"). Used for UI display.
+ "id": "A String", # Output only. Programmatic string identifier of the scope (e.g. GCP Project ID "my-project-id"). Used for API and code logic.
+ "name": "A String", # Output only. Resource name of the scope, e.g. "projects/1234567890".
+ },
+ ],
"createTime": "A String", # Output only. The time at which the RegistryBook was created.
"isDefault": True or False, # Output only. Whether the RegistryBook is the default one.
"labels": { # Optional. User-defined labels.
@@ -283,6 +297,13 @@ Method Details
"claimedScopes": [ # Optional. List of scopes claimed by the RegistryBook. In Preview, Only project scope is supported. Each scope is in the format of projects/{project}. Each scope can only be claimed once.
"A String",
],
+ "claimedScopesInfo": [ # Output only. Detailed scope information corresponding to each entry in `claimed_scopes`.
+ { # Details of a scope (e.g. project or folder).
+ "displayName": "A String", # Output only. Human-readable display title of the scope shown in Console (e.g. "My Cloud Project"). Used for UI display.
+ "id": "A String", # Output only. Programmatic string identifier of the scope (e.g. GCP Project ID "my-project-id"). Used for API and code logic.
+ "name": "A String", # Output only. Resource name of the scope, e.g. "projects/1234567890".
+ },
+ ],
"createTime": "A String", # Output only. The time at which the RegistryBook was created.
"isDefault": True or False, # Output only. Whether the RegistryBook is the default one.
"labels": { # Optional. User-defined labels.
@@ -332,6 +353,13 @@ Method Details
"claimedScopes": [ # Optional. List of scopes claimed by the RegistryBook. In Preview, Only project scope is supported. Each scope is in the format of projects/{project}. Each scope can only be claimed once.
"A String",
],
+ "claimedScopesInfo": [ # Output only. Detailed scope information corresponding to each entry in `claimed_scopes`.
+ { # Details of a scope (e.g. project or folder).
+ "displayName": "A String", # Output only. Human-readable display title of the scope shown in Console (e.g. "My Cloud Project"). Used for UI display.
+ "id": "A String", # Output only. Programmatic string identifier of the scope (e.g. GCP Project ID "my-project-id"). Used for API and code logic.
+ "name": "A String", # Output only. Resource name of the scope, e.g. "projects/1234567890".
+ },
+ ],
"createTime": "A String", # Output only. The time at which the RegistryBook was created.
"isDefault": True or False, # Output only. Whether the RegistryBook is the default one.
"labels": { # Optional. User-defined labels.
@@ -385,7 +413,7 @@ Method Details
"orderBy": "A String", # Optional. Hint for how to order the results. Supported sort fields are: - `name`: Sort alphabetically by the resource name. - `create_time`: Sort by the creation timestamp of the resource. - `update_time`: Sort by the last update timestamp of the resource. Supported directions are `asc` (ascending) and `desc` (descending). If unspecified, direction defaults to `asc`. Only sorting by a single field is supported.
"pageSize": 42, # Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
"pageToken": "A String", # Optional. A token identifying a page of results the server should return.
- "query": "A String", # Optional. Search query. This string filters resources in an AIP-160-like format. It has some limitations. You can only specify top level conjunctions or attribute level negations. Each restriction can only be used once except the attribute restriction. The available restrictions for Ranges are: - `realm`: The Realm name to search in. - `ip_address`: The IP address to search for within Ranges. - `ip_version`: The IP version to filter by (e.g., "IPV4", "IPV6"). - `parent_range`: The parent Range of the Range to search for. - `attribute_text`: The attribute text to search for within Ranges. - `attribute`: The attribute key and value to filter by. The available restrictions for Realms are: - `ip_version`: The IP version to search for. - `management_type`: The management type of the Realm (e.g., "CNR", "USER"). Only one of attribute_text or multiple attribute filters can be specified. Examples: - `realm=test-realm` - `realm=test-realm AND ip_address=10.0.0.0` - `realm=test-realm AND ip_version=IPV6` - `realm=test-realm AND attribute_text=test` - `ip_address=10.0.0.0 AND attribute:(key1=value1) AND attribute:(key2=value2)` - `attribute_text=test AND parent_range=projects/123/locations/global/discoveredRanges/test-parent-range` - `management_type=CNR`
+ "query": "A String", # Optional. Search query. This string filters resources in an AIP-160-like format. It has some limitations. You can only specify top level conjunctions or attribute level negations. Each restriction can only be used once except the attribute restriction. The available restrictions for Ranges are: - `resource_id`: The resource ID to search for within Ranges (only substring matching using the format `resource_id="*value*"` is supported). - `realm`: The Realm name to search in. - `ip_address`: The IP address to search for within Ranges. - `ip_version`: The IP version to filter by (e.g., "IPV4", "IPV6"). - `parent_range`: The parent Range of the Range to search for. - `attribute_text`: The attribute text to search for within Ranges. - `attribute`: The attribute key and value to filter by. The available restrictions for Realms are: - `ip_version`: The IP version to search for. - `management_type`: The management type of the Realm (e.g., "CNR", "USER"). Only one of attribute_text or multiple attribute filters can be specified. Examples: - `realm=test-realm` - `realm=test-realm AND ip_address=10.0.0.0` - `realm=test-realm AND ip_version=IPV6` - `realm=test-realm AND resource_id="*my-range*"` - `realm=test-realm AND attribute_text=test` - `ip_address=10.0.0.0 AND attribute:(key1=value1) AND attribute:(key2=value2)` - `attribute_text=test AND parent_range=projects/123/locations/global/discoveredRanges/test-parent-range` - `management_type=CNR`
"searchResourceTypes": [ # Optional. The type of resources to search for. If not specified, the server will return Ranges.
"A String",
],
diff --git a/googleapiclient/discovery_cache/documents/cloudnumberregistry.v1alpha.json b/googleapiclient/discovery_cache/documents/cloudnumberregistry.v1alpha.json
index d2b7f545d4..3fc888d250 100644
--- a/googleapiclient/discovery_cache/documents/cloudnumberregistry.v1alpha.json
+++ b/googleapiclient/discovery_cache/documents/cloudnumberregistry.v1alpha.json
@@ -1735,7 +1735,7 @@
}
}
},
-"revision": "20260819",
+"revision": "20260826",
"rootUrl": "https://cloudnumberregistry.googleapis.com/",
"schemas": {
"AggregatedData": {
@@ -2690,6 +2690,14 @@ true
},
"type": "array"
},
+"claimedScopesInfo": {
+"description": "Output only. Detailed scope information corresponding to each entry in `claimed_scopes`.",
+"items": {
+"$ref": "ScopeInfo"
+},
+"readOnly": true,
+"type": "array"
+},
"createTime": {
"description": "Output only. The time at which the RegistryBook was created.",
"format": "google-datetime",
@@ -2721,6 +2729,28 @@ true
},
"type": "object"
},
+"ScopeInfo": {
+"description": "Details of a scope (e.g. project or folder).",
+"id": "ScopeInfo",
+"properties": {
+"displayName": {
+"description": "Output only. Human-readable display title of the scope shown in Console (e.g. \"My Cloud Project\"). Used for UI display.",
+"readOnly": true,
+"type": "string"
+},
+"id": {
+"description": "Output only. Programmatic string identifier of the scope (e.g. GCP Project ID \"my-project-id\"). Used for API and code logic.",
+"readOnly": true,
+"type": "string"
+},
+"name": {
+"description": "Output only. Resource name of the scope, e.g. \"projects/1234567890\".",
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
"SearchIpResourcesRequest": {
"description": "Request message for the CloudNumberRegistry.SearchIpResources method.",
"id": "SearchIpResourcesRequest",
@@ -2739,7 +2769,7 @@ true
"type": "string"
},
"query": {
-"description": "Optional. Search query. This string filters resources in an AIP-160-like format. It has some limitations. You can only specify top level conjunctions or attribute level negations. Each restriction can only be used once except the attribute restriction. The available restrictions for Ranges are: - `realm`: The Realm name to search in. - `ip_address`: The IP address to search for within Ranges. - `ip_version`: The IP version to filter by (e.g., \"IPV4\", \"IPV6\"). - `parent_range`: The parent Range of the Range to search for. - `attribute_text`: The attribute text to search for within Ranges. - `attribute`: The attribute key and value to filter by. The available restrictions for Realms are: - `ip_version`: The IP version to search for. - `management_type`: The management type of the Realm (e.g., \"CNR\", \"USER\"). Only one of attribute_text or multiple attribute filters can be specified. Examples: - `realm=test-realm` - `realm=test-realm AND ip_address=10.0.0.0` - `realm=test-realm AND ip_version=IPV6` - `realm=test-realm AND attribute_text=test` - `ip_address=10.0.0.0 AND attribute:(key1=value1) AND attribute:(key2=value2)` - `attribute_text=test AND parent_range=projects/123/locations/global/discoveredRanges/test-parent-range` - `management_type=CNR`",
+"description": "Optional. Search query. This string filters resources in an AIP-160-like format. It has some limitations. You can only specify top level conjunctions or attribute level negations. Each restriction can only be used once except the attribute restriction. The available restrictions for Ranges are: - `resource_id`: The resource ID to search for within Ranges (only substring matching using the format `resource_id=\"*value*\"` is supported). - `realm`: The Realm name to search in. - `ip_address`: The IP address to search for within Ranges. - `ip_version`: The IP version to filter by (e.g., \"IPV4\", \"IPV6\"). - `parent_range`: The parent Range of the Range to search for. - `attribute_text`: The attribute text to search for within Ranges. - `attribute`: The attribute key and value to filter by. The available restrictions for Realms are: - `ip_version`: The IP version to search for. - `management_type`: The management type of the Realm (e.g., \"CNR\", \"USER\"). Only one of attribute_text or multiple attribute filters can be specified. Examples: - `realm=test-realm` - `realm=test-realm AND ip_address=10.0.0.0` - `realm=test-realm AND ip_version=IPV6` - `realm=test-realm AND resource_id=\"*my-range*\"` - `realm=test-realm AND attribute_text=test` - `ip_address=10.0.0.0 AND attribute:(key1=value1) AND attribute:(key2=value2)` - `attribute_text=test AND parent_range=projects/123/locations/global/discoveredRanges/test-parent-range` - `management_type=CNR`",
"type": "string"
},
"searchResourceTypes": {
From bf54db2fd7835451e5cc5cf352034f288f7a558c Mon Sep 17 00:00:00 2001
From: Yoshi Automation
Date: Tue, 8 Sep 2026 07:20:12 +0000
Subject: [PATCH 13/40] feat(cloudresourcemanager): update the api
#### cloudresourcemanager:v1
The following keys were added:
- schemas.CreateBoundaryMetadata (Total Keys: 2)
- schemas.CreateCapabilityConfigMetadata (Total Keys: 2)
- schemas.DeleteBoundaryMetadata (Total Keys: 2)
- schemas.DeleteCapabilityConfigMetadata (Total Keys: 2)
- schemas.Project.properties.isManagementProject (Total Keys: 2)
- schemas.UpdateBoundaryConfigMetadata (Total Keys: 2)
- schemas.UpdateBoundaryMetadata (Total Keys: 2)
- schemas.UpdateCapabilityConfigMetadata (Total Keys: 2)
#### cloudresourcemanager:v1beta1
The following keys were added:
- schemas.CreateBoundaryMetadata (Total Keys: 2)
- schemas.CreateCapabilityConfigMetadata (Total Keys: 2)
- schemas.DeleteBoundaryMetadata (Total Keys: 2)
- schemas.DeleteCapabilityConfigMetadata (Total Keys: 2)
- schemas.Project.properties.isManagementProject (Total Keys: 2)
- schemas.UpdateBoundaryConfigMetadata (Total Keys: 2)
- schemas.UpdateBoundaryMetadata (Total Keys: 2)
- schemas.UpdateCapabilityConfigMetadata (Total Keys: 2)
#### cloudresourcemanager:v2
The following keys were added:
- schemas.CreateBoundaryMetadata (Total Keys: 2)
- schemas.CreateCapabilityConfigMetadata (Total Keys: 2)
- schemas.DeleteBoundaryMetadata (Total Keys: 2)
- schemas.DeleteCapabilityConfigMetadata (Total Keys: 2)
- schemas.UpdateBoundaryConfigMetadata (Total Keys: 2)
- schemas.UpdateBoundaryMetadata (Total Keys: 2)
- schemas.UpdateCapabilityConfigMetadata (Total Keys: 2)
#### cloudresourcemanager:v2beta1
The following keys were added:
- schemas.CreateBoundaryMetadata (Total Keys: 2)
- schemas.CreateCapabilityConfigMetadata (Total Keys: 2)
- schemas.DeleteBoundaryMetadata (Total Keys: 2)
- schemas.DeleteCapabilityConfigMetadata (Total Keys: 2)
- schemas.UpdateBoundaryConfigMetadata (Total Keys: 2)
- schemas.UpdateBoundaryMetadata (Total Keys: 2)
- schemas.UpdateCapabilityConfigMetadata (Total Keys: 2)
#### cloudresourcemanager:v3
The following keys were added:
- schemas.CreateBoundaryMetadata (Total Keys: 2)
- schemas.CreateCapabilityConfigMetadata (Total Keys: 2)
- schemas.DeleteBoundaryMetadata (Total Keys: 2)
- schemas.DeleteCapabilityConfigMetadata (Total Keys: 2)
- schemas.Project.properties.isManagementProject (Total Keys: 2)
- schemas.UpdateBoundaryConfigMetadata (Total Keys: 2)
- schemas.UpdateBoundaryMetadata (Total Keys: 2)
- schemas.UpdateCapabilityConfigMetadata (Total Keys: 2)
---
.../dyn/cloudresourcemanager_v1.projects.html | 5 ++
...cloudresourcemanager_v1beta1.projects.html | 6 +++
.../dyn/cloudresourcemanager_v3.projects.html | 5 ++
.../documents/cloudresourcemanager.v1.json | 49 ++++++++++++++++++-
.../cloudresourcemanager.v1beta1.json | 49 ++++++++++++++++++-
.../documents/cloudresourcemanager.v2.json | 44 ++++++++++++++++-
.../cloudresourcemanager.v2beta1.json | 44 ++++++++++++++++-
.../documents/cloudresourcemanager.v3.json | 49 ++++++++++++++++++-
8 files changed, 246 insertions(+), 5 deletions(-)
diff --git a/docs/dyn/cloudresourcemanager_v1.projects.html b/docs/dyn/cloudresourcemanager_v1.projects.html
index b38d046931..8033eb6641 100644
--- a/docs/dyn/cloudresourcemanager_v1.projects.html
+++ b/docs/dyn/cloudresourcemanager_v1.projects.html
@@ -179,6 +179,7 @@ Method Details
"A String",
],
"createTime": "A String", # Creation time. Read-only.
+ "isManagementProject": True or False, # Output only. If `true`, this project is a Management Project. A Management Project manages dedicated project groups for specific purposes (e.g., agent management or app management).
"labels": { # The labels associated with this Project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z{0,62}. Label values must be between 0 and 63 characters long and must conform to the regular expression [a-z0-9_-]{0,63}. A label value can be empty. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: "environment" : "dev" Read-write.
"a_key": "A String",
},
@@ -261,6 +262,7 @@ Method Details
"A String",
],
"createTime": "A String", # Creation time. Read-only.
+ "isManagementProject": True or False, # Output only. If `true`, this project is a Management Project. A Management Project manages dedicated project groups for specific purposes (e.g., agent management or app management).
"labels": { # The labels associated with this Project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z{0,62}. Label values must be between 0 and 63 characters long and must conform to the regular expression [a-z0-9_-]{0,63}. A label value can be empty. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: "environment" : "dev" Read-write.
"a_key": "A String",
},
@@ -480,6 +482,7 @@ Method Details
"A String",
],
"createTime": "A String", # Creation time. Read-only.
+ "isManagementProject": True or False, # Output only. If `true`, this project is a Management Project. A Management Project manages dedicated project groups for specific purposes (e.g., agent management or app management).
"labels": { # The labels associated with this Project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z{0,62}. Label values must be between 0 and 63 characters long and must conform to the regular expression [a-z0-9_-]{0,63}. A label value can be empty. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: "environment" : "dev" Read-write.
"a_key": "A String",
},
@@ -853,6 +856,7 @@ Method Details
"A String",
],
"createTime": "A String", # Creation time. Read-only.
+ "isManagementProject": True or False, # Output only. If `true`, this project is a Management Project. A Management Project manages dedicated project groups for specific purposes (e.g., agent management or app management).
"labels": { # The labels associated with this Project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z{0,62}. Label values must be between 0 and 63 characters long and must conform to the regular expression [a-z0-9_-]{0,63}. A label value can be empty. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: "environment" : "dev" Read-write.
"a_key": "A String",
},
@@ -882,6 +886,7 @@ Method Details
"A String",
],
"createTime": "A String", # Creation time. Read-only.
+ "isManagementProject": True or False, # Output only. If `true`, this project is a Management Project. A Management Project manages dedicated project groups for specific purposes (e.g., agent management or app management).
"labels": { # The labels associated with this Project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z{0,62}. Label values must be between 0 and 63 characters long and must conform to the regular expression [a-z0-9_-]{0,63}. A label value can be empty. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: "environment" : "dev" Read-write.
"a_key": "A String",
},
diff --git a/docs/dyn/cloudresourcemanager_v1beta1.projects.html b/docs/dyn/cloudresourcemanager_v1beta1.projects.html
index f2a6967ac4..25cd588cc5 100644
--- a/docs/dyn/cloudresourcemanager_v1beta1.projects.html
+++ b/docs/dyn/cloudresourcemanager_v1beta1.projects.html
@@ -129,6 +129,7 @@ Method Details
"A String",
],
"createTime": "A String", # Creation time. Read-only.
+ "isManagementProject": True or False, # Output only. If `true`, this project is a Management Project. A Management Project manages dedicated project groups for specific purposes (e.g., agent management or app management).
"labels": { # The labels associated with this Project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z{0,62}. Label values must be between 0 and 63 characters long and must conform to the regular expression [a-z0-9_-]{0,63}. A label value can be empty. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: `"environment" : "dev"` Read-write.
"a_key": "A String",
},
@@ -156,6 +157,7 @@ Method Details
"A String",
],
"createTime": "A String", # Creation time. Read-only.
+ "isManagementProject": True or False, # Output only. If `true`, this project is a Management Project. A Management Project manages dedicated project groups for specific purposes (e.g., agent management or app management).
"labels": { # The labels associated with this Project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z{0,62}. Label values must be between 0 and 63 characters long and must conform to the regular expression [a-z0-9_-]{0,63}. A label value can be empty. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: `"environment" : "dev"` Read-write.
"a_key": "A String",
},
@@ -207,6 +209,7 @@ Method Details
"A String",
],
"createTime": "A String", # Creation time. Read-only.
+ "isManagementProject": True or False, # Output only. If `true`, this project is a Management Project. A Management Project manages dedicated project groups for specific purposes (e.g., agent management or app management).
"labels": { # The labels associated with this Project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z{0,62}. Label values must be between 0 and 63 characters long and must conform to the regular expression [a-z0-9_-]{0,63}. A label value can be empty. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: `"environment" : "dev"` Read-write.
"a_key": "A String",
},
@@ -333,6 +336,7 @@ Method Details
"A String",
],
"createTime": "A String", # Creation time. Read-only.
+ "isManagementProject": True or False, # Output only. If `true`, this project is a Management Project. A Management Project manages dedicated project groups for specific purposes (e.g., agent management or app management).
"labels": { # The labels associated with this Project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z{0,62}. Label values must be between 0 and 63 characters long and must conform to the regular expression [a-z0-9_-]{0,63}. A label value can be empty. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: `"environment" : "dev"` Read-write.
"a_key": "A String",
},
@@ -516,6 +520,7 @@ Method Details
"A String",
],
"createTime": "A String", # Creation time. Read-only.
+ "isManagementProject": True or False, # Output only. If `true`, this project is a Management Project. A Management Project manages dedicated project groups for specific purposes (e.g., agent management or app management).
"labels": { # The labels associated with this Project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z{0,62}. Label values must be between 0 and 63 characters long and must conform to the regular expression [a-z0-9_-]{0,63}. A label value can be empty. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: `"environment" : "dev"` Read-write.
"a_key": "A String",
},
@@ -542,6 +547,7 @@ Method Details
"A String",
],
"createTime": "A String", # Creation time. Read-only.
+ "isManagementProject": True or False, # Output only. If `true`, this project is a Management Project. A Management Project manages dedicated project groups for specific purposes (e.g., agent management or app management).
"labels": { # The labels associated with this Project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z{0,62}. Label values must be between 0 and 63 characters long and must conform to the regular expression [a-z0-9_-]{0,63}. A label value can be empty. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: `"environment" : "dev"` Read-write.
"a_key": "A String",
},
diff --git a/docs/dyn/cloudresourcemanager_v3.projects.html b/docs/dyn/cloudresourcemanager_v3.projects.html
index 6b55bef832..9ba06660bb 100644
--- a/docs/dyn/cloudresourcemanager_v3.projects.html
+++ b/docs/dyn/cloudresourcemanager_v3.projects.html
@@ -138,6 +138,7 @@ Method Details
"deleteTime": "A String", # Output only. The time at which this resource was requested for deletion.
"displayName": "A String", # Optional. A user-assigned display name of the project. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: `My Project`
"etag": "A String", # Output only. A checksum computed by the server based on the current value of the Project resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+ "isManagementProject": True or False, # Output only. If `true`, this project is a Management Project. A Management Project manages dedicated project groups for specific purposes (e.g., agent management or app management).
"labels": { # Optional. The labels associated with this project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. Label values must be between 0 and 63 characters long and must conform to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. No more than 64 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: `"myBusinessDimension" : "businessValue"`
"a_key": "A String",
},
@@ -237,6 +238,7 @@ Method Details
"deleteTime": "A String", # Output only. The time at which this resource was requested for deletion.
"displayName": "A String", # Optional. A user-assigned display name of the project. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: `My Project`
"etag": "A String", # Output only. A checksum computed by the server based on the current value of the Project resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+ "isManagementProject": True or False, # Output only. If `true`, this project is a Management Project. A Management Project manages dedicated project groups for specific purposes (e.g., agent management or app management).
"labels": { # Optional. The labels associated with this project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. Label values must be between 0 and 63 characters long and must conform to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. No more than 64 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: `"myBusinessDimension" : "businessValue"`
"a_key": "A String",
},
@@ -335,6 +337,7 @@ Method Details
"deleteTime": "A String", # Output only. The time at which this resource was requested for deletion.
"displayName": "A String", # Optional. A user-assigned display name of the project. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: `My Project`
"etag": "A String", # Output only. A checksum computed by the server based on the current value of the Project resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+ "isManagementProject": True or False, # Output only. If `true`, this project is a Management Project. A Management Project manages dedicated project groups for specific purposes (e.g., agent management or app management).
"labels": { # Optional. The labels associated with this project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. Label values must be between 0 and 63 characters long and must conform to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. No more than 64 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: `"myBusinessDimension" : "businessValue"`
"a_key": "A String",
},
@@ -424,6 +427,7 @@ Method Details
"deleteTime": "A String", # Output only. The time at which this resource was requested for deletion.
"displayName": "A String", # Optional. A user-assigned display name of the project. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: `My Project`
"etag": "A String", # Output only. A checksum computed by the server based on the current value of the Project resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+ "isManagementProject": True or False, # Output only. If `true`, this project is a Management Project. A Management Project manages dedicated project groups for specific purposes (e.g., agent management or app management).
"labels": { # Optional. The labels associated with this project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. Label values must be between 0 and 63 characters long and must conform to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. No more than 64 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: `"myBusinessDimension" : "businessValue"`
"a_key": "A String",
},
@@ -494,6 +498,7 @@ Method Details
"deleteTime": "A String", # Output only. The time at which this resource was requested for deletion.
"displayName": "A String", # Optional. A user-assigned display name of the project. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: `My Project`
"etag": "A String", # Output only. A checksum computed by the server based on the current value of the Project resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+ "isManagementProject": True or False, # Output only. If `true`, this project is a Management Project. A Management Project manages dedicated project groups for specific purposes (e.g., agent management or app management).
"labels": { # Optional. The labels associated with this project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. Label values must be between 0 and 63 characters long and must conform to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. No more than 64 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: `"myBusinessDimension" : "businessValue"`
"a_key": "A String",
},
diff --git a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1.json b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1.json
index 2dbb010be6..1984972b35 100644
--- a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1.json
+++ b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1.json
@@ -1171,7 +1171,7 @@
}
}
},
-"revision": "20251103",
+"revision": "20260820",
"rootUrl": "https://cloudresourcemanager.googleapis.com/",
"schemas": {
"Ancestor": {
@@ -1400,6 +1400,18 @@
},
"type": "object"
},
+"CreateBoundaryMetadata": {
+"description": "A status object which is used as the `metadata` field for the Operation returned by CreateBoundary. Currently empty.",
+"id": "CreateBoundaryMetadata",
+"properties": {},
+"type": "object"
+},
+"CreateCapabilityConfigMetadata": {
+"description": "A status object which is used as the `metadata` field for the Operation returned by CreateCapabilityConfig. Currently empty.",
+"id": "CreateCapabilityConfigMetadata",
+"properties": {},
+"type": "object"
+},
"CreateFolderMetadata": {
"description": "Metadata pertaining to the Folder creation process.",
"id": "CreateFolderMetadata",
@@ -1453,6 +1465,18 @@
"properties": {},
"type": "object"
},
+"DeleteBoundaryMetadata": {
+"description": "A status object which is used as the `metadata` field for the Operation returned by DeleteBoundary. Currently empty.",
+"id": "DeleteBoundaryMetadata",
+"properties": {},
+"type": "object"
+},
+"DeleteCapabilityConfigMetadata": {
+"description": "A status object which is used as the `metadata` field for the Operation returned by DeleteCapabilityConfig. Currently empty.",
+"id": "DeleteCapabilityConfigMetadata",
+"properties": {},
+"type": "object"
+},
"DeleteFolderMetadata": {
"description": "A status object which is used as the `metadata` field for the `Operation` returned by `DeleteFolder`.",
"id": "DeleteFolderMetadata",
@@ -2045,6 +2069,11 @@
"format": "google-datetime",
"type": "string"
},
+"isManagementProject": {
+"description": "Output only. If `true`, this project is a Management Project. A Management Project manages dedicated project groups for specific purposes (e.g., agent management or app management).",
+"readOnly": true,
+"type": "boolean"
+},
"labels": {
"additionalProperties": {
"type": "string"
@@ -2280,6 +2309,24 @@
"properties": {},
"type": "object"
},
+"UpdateBoundaryConfigMetadata": {
+"description": "A status object which is used as the `metadata` field for the Operation returned by UpdateBoundaryConfig. Currently empty.",
+"id": "UpdateBoundaryConfigMetadata",
+"properties": {},
+"type": "object"
+},
+"UpdateBoundaryMetadata": {
+"description": "A status object which is used as the `metadata` field for the Operation returned by UpdateBoundary. Currently empty.",
+"id": "UpdateBoundaryMetadata",
+"properties": {},
+"type": "object"
+},
+"UpdateCapabilityConfigMetadata": {
+"description": "A status object which is used as the `metadata` field for the Operation returned by UpdateCapabilityConfig. Currently empty.",
+"id": "UpdateCapabilityConfigMetadata",
+"properties": {},
+"type": "object"
+},
"UpdateFolderMetadata": {
"description": "A status object which is used as the `metadata` field for the Operation returned by UpdateFolder.",
"id": "UpdateFolderMetadata",
diff --git a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1beta1.json b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1beta1.json
index 8ae6c19e26..2687fda209 100644
--- a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1beta1.json
@@ -568,7 +568,7 @@
}
}
},
-"revision": "20251103",
+"revision": "20260820",
"rootUrl": "https://cloudresourcemanager.googleapis.com/",
"schemas": {
"Ancestor": {
@@ -718,6 +718,18 @@
},
"type": "object"
},
+"CreateBoundaryMetadata": {
+"description": "A status object which is used as the `metadata` field for the Operation returned by CreateBoundary. Currently empty.",
+"id": "CreateBoundaryMetadata",
+"properties": {},
+"type": "object"
+},
+"CreateCapabilityConfigMetadata": {
+"description": "A status object which is used as the `metadata` field for the Operation returned by CreateCapabilityConfig. Currently empty.",
+"id": "CreateCapabilityConfigMetadata",
+"properties": {},
+"type": "object"
+},
"CreateFolderMetadata": {
"description": "Metadata pertaining to the Folder creation process.",
"id": "CreateFolderMetadata",
@@ -771,6 +783,18 @@
"properties": {},
"type": "object"
},
+"DeleteBoundaryMetadata": {
+"description": "A status object which is used as the `metadata` field for the Operation returned by DeleteBoundary. Currently empty.",
+"id": "DeleteBoundaryMetadata",
+"properties": {},
+"type": "object"
+},
+"DeleteCapabilityConfigMetadata": {
+"description": "A status object which is used as the `metadata` field for the Operation returned by DeleteCapabilityConfig. Currently empty.",
+"id": "DeleteCapabilityConfigMetadata",
+"properties": {},
+"type": "object"
+},
"DeleteFolderMetadata": {
"description": "A status object which is used as the `metadata` field for the `Operation` returned by `DeleteFolder`.",
"id": "DeleteFolderMetadata",
@@ -1112,6 +1136,11 @@
"format": "google-datetime",
"type": "string"
},
+"isManagementProject": {
+"description": "Output only. If `true`, this project is a Management Project. A Management Project manages dedicated project groups for specific purposes (e.g., agent management or app management).",
+"readOnly": true,
+"type": "boolean"
+},
"labels": {
"additionalProperties": {
"type": "string"
@@ -1258,6 +1287,24 @@
"properties": {},
"type": "object"
},
+"UpdateBoundaryConfigMetadata": {
+"description": "A status object which is used as the `metadata` field for the Operation returned by UpdateBoundaryConfig. Currently empty.",
+"id": "UpdateBoundaryConfigMetadata",
+"properties": {},
+"type": "object"
+},
+"UpdateBoundaryMetadata": {
+"description": "A status object which is used as the `metadata` field for the Operation returned by UpdateBoundary. Currently empty.",
+"id": "UpdateBoundaryMetadata",
+"properties": {},
+"type": "object"
+},
+"UpdateCapabilityConfigMetadata": {
+"description": "A status object which is used as the `metadata` field for the Operation returned by UpdateCapabilityConfig. Currently empty.",
+"id": "UpdateCapabilityConfigMetadata",
+"properties": {},
+"type": "object"
+},
"UpdateFolderMetadata": {
"description": "A status object which is used as the `metadata` field for the Operation returned by UpdateFolder.",
"id": "UpdateFolderMetadata",
diff --git a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2.json b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2.json
index 0269673d76..036e0df5c4 100644
--- a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2.json
+++ b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2.json
@@ -450,7 +450,7 @@
}
}
},
-"revision": "20251103",
+"revision": "20260820",
"rootUrl": "https://cloudresourcemanager.googleapis.com/",
"schemas": {
"AuditConfig": {
@@ -589,6 +589,18 @@
},
"type": "object"
},
+"CreateBoundaryMetadata": {
+"description": "A status object which is used as the `metadata` field for the Operation returned by CreateBoundary. Currently empty.",
+"id": "CreateBoundaryMetadata",
+"properties": {},
+"type": "object"
+},
+"CreateCapabilityConfigMetadata": {
+"description": "A status object which is used as the `metadata` field for the Operation returned by CreateCapabilityConfig. Currently empty.",
+"id": "CreateCapabilityConfigMetadata",
+"properties": {},
+"type": "object"
+},
"CreateFolderMetadata": {
"description": "Metadata pertaining to the Folder creation process.",
"id": "CreateFolderMetadata",
@@ -642,6 +654,18 @@
"properties": {},
"type": "object"
},
+"DeleteBoundaryMetadata": {
+"description": "A status object which is used as the `metadata` field for the Operation returned by DeleteBoundary. Currently empty.",
+"id": "DeleteBoundaryMetadata",
+"properties": {},
+"type": "object"
+},
+"DeleteCapabilityConfigMetadata": {
+"description": "A status object which is used as the `metadata` field for the Operation returned by DeleteCapabilityConfig. Currently empty.",
+"id": "DeleteCapabilityConfigMetadata",
+"properties": {},
+"type": "object"
+},
"DeleteFolderMetadata": {
"description": "A status object which is used as the `metadata` field for the `Operation` returned by `DeleteFolder`.",
"id": "DeleteFolderMetadata",
@@ -1128,6 +1152,24 @@
"properties": {},
"type": "object"
},
+"UpdateBoundaryConfigMetadata": {
+"description": "A status object which is used as the `metadata` field for the Operation returned by UpdateBoundaryConfig. Currently empty.",
+"id": "UpdateBoundaryConfigMetadata",
+"properties": {},
+"type": "object"
+},
+"UpdateBoundaryMetadata": {
+"description": "A status object which is used as the `metadata` field for the Operation returned by UpdateBoundary. Currently empty.",
+"id": "UpdateBoundaryMetadata",
+"properties": {},
+"type": "object"
+},
+"UpdateCapabilityConfigMetadata": {
+"description": "A status object which is used as the `metadata` field for the Operation returned by UpdateCapabilityConfig. Currently empty.",
+"id": "UpdateCapabilityConfigMetadata",
+"properties": {},
+"type": "object"
+},
"UpdateFolderMetadata": {
"description": "A status object which is used as the `metadata` field for the Operation returned by UpdateFolder.",
"id": "UpdateFolderMetadata",
diff --git a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2beta1.json b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2beta1.json
index 2c69558d00..7046f4f05f 100644
--- a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2beta1.json
+++ b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2beta1.json
@@ -450,7 +450,7 @@
}
}
},
-"revision": "20251103",
+"revision": "20260820",
"rootUrl": "https://cloudresourcemanager.googleapis.com/",
"schemas": {
"AuditConfig": {
@@ -589,6 +589,18 @@
},
"type": "object"
},
+"CreateBoundaryMetadata": {
+"description": "A status object which is used as the `metadata` field for the Operation returned by CreateBoundary. Currently empty.",
+"id": "CreateBoundaryMetadata",
+"properties": {},
+"type": "object"
+},
+"CreateCapabilityConfigMetadata": {
+"description": "A status object which is used as the `metadata` field for the Operation returned by CreateCapabilityConfig. Currently empty.",
+"id": "CreateCapabilityConfigMetadata",
+"properties": {},
+"type": "object"
+},
"CreateFolderMetadata": {
"description": "Metadata pertaining to the Folder creation process.",
"id": "CreateFolderMetadata",
@@ -642,6 +654,18 @@
"properties": {},
"type": "object"
},
+"DeleteBoundaryMetadata": {
+"description": "A status object which is used as the `metadata` field for the Operation returned by DeleteBoundary. Currently empty.",
+"id": "DeleteBoundaryMetadata",
+"properties": {},
+"type": "object"
+},
+"DeleteCapabilityConfigMetadata": {
+"description": "A status object which is used as the `metadata` field for the Operation returned by DeleteCapabilityConfig. Currently empty.",
+"id": "DeleteCapabilityConfigMetadata",
+"properties": {},
+"type": "object"
+},
"DeleteFolderMetadata": {
"description": "A status object which is used as the `metadata` field for the `Operation` returned by `DeleteFolder`.",
"id": "DeleteFolderMetadata",
@@ -1128,6 +1152,24 @@
"properties": {},
"type": "object"
},
+"UpdateBoundaryConfigMetadata": {
+"description": "A status object which is used as the `metadata` field for the Operation returned by UpdateBoundaryConfig. Currently empty.",
+"id": "UpdateBoundaryConfigMetadata",
+"properties": {},
+"type": "object"
+},
+"UpdateBoundaryMetadata": {
+"description": "A status object which is used as the `metadata` field for the Operation returned by UpdateBoundary. Currently empty.",
+"id": "UpdateBoundaryMetadata",
+"properties": {},
+"type": "object"
+},
+"UpdateCapabilityConfigMetadata": {
+"description": "A status object which is used as the `metadata` field for the Operation returned by UpdateCapabilityConfig. Currently empty.",
+"id": "UpdateCapabilityConfigMetadata",
+"properties": {},
+"type": "object"
+},
"UpdateFolderMetadata": {
"description": "A status object which is used as the `metadata` field for the Operation returned by UpdateFolder.",
"id": "UpdateFolderMetadata",
diff --git a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v3.json b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v3.json
index 6af2204b37..43ee157e47 100644
--- a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v3.json
+++ b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v3.json
@@ -1994,7 +1994,7 @@
}
}
},
-"revision": "20260715",
+"revision": "20260820",
"rootUrl": "https://cloudresourcemanager.googleapis.com/",
"schemas": {
"AuditConfig": {
@@ -2148,6 +2148,18 @@
},
"type": "object"
},
+"CreateBoundaryMetadata": {
+"description": "A status object which is used as the `metadata` field for the Operation returned by CreateBoundary. Currently empty.",
+"id": "CreateBoundaryMetadata",
+"properties": {},
+"type": "object"
+},
+"CreateCapabilityConfigMetadata": {
+"description": "A status object which is used as the `metadata` field for the Operation returned by CreateCapabilityConfig. Currently empty.",
+"id": "CreateCapabilityConfigMetadata",
+"properties": {},
+"type": "object"
+},
"CreateFolderMetadata": {
"description": "Metadata pertaining to the Folder creation process.",
"id": "CreateFolderMetadata",
@@ -2201,6 +2213,18 @@
"properties": {},
"type": "object"
},
+"DeleteBoundaryMetadata": {
+"description": "A status object which is used as the `metadata` field for the Operation returned by DeleteBoundary. Currently empty.",
+"id": "DeleteBoundaryMetadata",
+"properties": {},
+"type": "object"
+},
+"DeleteCapabilityConfigMetadata": {
+"description": "A status object which is used as the `metadata` field for the Operation returned by DeleteCapabilityConfig. Currently empty.",
+"id": "DeleteCapabilityConfigMetadata",
+"properties": {},
+"type": "object"
+},
"DeleteFolderMetadata": {
"description": "A status object which is used as the `metadata` field for the `Operation` returned by `DeleteFolder`.",
"id": "DeleteFolderMetadata",
@@ -2891,6 +2915,11 @@
"readOnly": true,
"type": "string"
},
+"isManagementProject": {
+"description": "Output only. If `true`, this project is a Management Project. A Management Project manages dedicated project groups for specific purposes (e.g., agent management or app management).",
+"readOnly": true,
+"type": "boolean"
+},
"labels": {
"additionalProperties": {
"type": "string"
@@ -3310,6 +3339,24 @@
"properties": {},
"type": "object"
},
+"UpdateBoundaryConfigMetadata": {
+"description": "A status object which is used as the `metadata` field for the Operation returned by UpdateBoundaryConfig. Currently empty.",
+"id": "UpdateBoundaryConfigMetadata",
+"properties": {},
+"type": "object"
+},
+"UpdateBoundaryMetadata": {
+"description": "A status object which is used as the `metadata` field for the Operation returned by UpdateBoundary. Currently empty.",
+"id": "UpdateBoundaryMetadata",
+"properties": {},
+"type": "object"
+},
+"UpdateCapabilityConfigMetadata": {
+"description": "A status object which is used as the `metadata` field for the Operation returned by UpdateCapabilityConfig. Currently empty.",
+"id": "UpdateCapabilityConfigMetadata",
+"properties": {},
+"type": "object"
+},
"UpdateFolderMetadata": {
"description": "A status object which is used as the `metadata` field for the Operation returned by UpdateFolder.",
"id": "UpdateFolderMetadata",
From 0b2bb995bb88dffda82302b76ed7229d38052679 Mon Sep 17 00:00:00 2001
From: Yoshi Automation
Date: Tue, 8 Sep 2026 07:20:12 +0000
Subject: [PATCH 14/40] feat(cloudtasks): update the api
#### cloudtasks:v2
The following keys were added:
- resources.projects.resources.locations.resources.operations.methods.get (Total Keys: 11)
- schemas.Operation (Total Keys: 9)
---
.../dyn/cloudtasks_v2.projects.locations.html | 5 +
...asks_v2.projects.locations.operations.html | 124 ++++++++++++++++++
...oudtasks_v2.projects.locations.queues.html | 18 +--
...sks_v2beta2.projects.locations.queues.html | 18 +--
...sks_v2beta3.projects.locations.queues.html | 18 +--
.../documents/cloudtasks.v2.json | 68 +++++++++-
.../documents/cloudtasks.v2beta2.json | 4 +-
.../documents/cloudtasks.v2beta3.json | 4 +-
8 files changed, 226 insertions(+), 33 deletions(-)
create mode 100644 docs/dyn/cloudtasks_v2.projects.locations.operations.html
diff --git a/docs/dyn/cloudtasks_v2.projects.locations.html b/docs/dyn/cloudtasks_v2.projects.locations.html
index 6a9cd3a90a..d4d2fc1603 100644
--- a/docs/dyn/cloudtasks_v2.projects.locations.html
+++ b/docs/dyn/cloudtasks_v2.projects.locations.html
@@ -74,6 +74,11 @@
Cloud Tasks API . projects . locations
Instance Methods
+
+ operations()
+
+Returns the operations Resource.
+
diff --git a/docs/dyn/cloudtasks_v2.projects.locations.operations.html b/docs/dyn/cloudtasks_v2.projects.locations.operations.html
new file mode 100644
index 0000000000..452a4d4730
--- /dev/null
+++ b/docs/dyn/cloudtasks_v2.projects.locations.operations.html
@@ -0,0 +1,124 @@
+
+
+
+Cloud Tasks API . projects . locations . operations
+Instance Methods
+
+ close()
+Close httplib2 connections.
+
+Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
+Method Details
+
+ close()
+ Close httplib2 connections.
+
+
+
+ get(name, x__xgafv=None)
+ Gets the latest 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.
+ },
+}
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/cloudtasks_v2.projects.locations.queues.html b/docs/dyn/cloudtasks_v2.projects.locations.queues.html
index 73b4f46225..b57ad9a140 100644
--- a/docs/dyn/cloudtasks_v2.projects.locations.queues.html
+++ b/docs/dyn/cloudtasks_v2.projects.locations.queues.html
@@ -140,7 +140,7 @@ Method Details
"service": "A String", # App service. By default, the task is sent to the service which is the default service when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
"version": "A String", # App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
},
- "httpTarget": { # HTTP target. When specified as a Queue, all the tasks with [HttpRequest] will be overridden according to the target. # Modifies HTTP target for HTTP tasks.
+ "httpTarget": { # HTTP target. When specified at the Queue level, all tasks with HttpRequest are overridden according to the target. # Modifies HTTP target for HTTP tasks.
"headerOverrides": [ # HTTP target headers. This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask. These headers represent a subset of the headers that will be configured for the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example,`Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. The default value is set to "application/json"`. * User-Agent: This will be set to `"Google-Cloud-Tasks"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
{ # Wraps the Header object.
"header": { # Defines a header message. A header can have a key and a value. # Header embodying a key and a value. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
@@ -206,7 +206,7 @@ Method Details
"service": "A String", # App service. By default, the task is sent to the service which is the default service when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
"version": "A String", # App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
},
- "httpTarget": { # HTTP target. When specified as a Queue, all the tasks with [HttpRequest] will be overridden according to the target. # Modifies HTTP target for HTTP tasks.
+ "httpTarget": { # HTTP target. When specified at the Queue level, all tasks with HttpRequest are overridden according to the target. # Modifies HTTP target for HTTP tasks.
"headerOverrides": [ # HTTP target headers. This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask. These headers represent a subset of the headers that will be configured for the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example,`Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. The default value is set to "application/json"`. * User-Agent: This will be set to `"Google-Cloud-Tasks"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
{ # Wraps the Header object.
"header": { # Defines a header message. A header can have a key and a value. # Header embodying a key and a value. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
@@ -297,7 +297,7 @@ Method Details
"service": "A String", # App service. By default, the task is sent to the service which is the default service when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
"version": "A String", # App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
},
- "httpTarget": { # HTTP target. When specified as a Queue, all the tasks with [HttpRequest] will be overridden according to the target. # Modifies HTTP target for HTTP tasks.
+ "httpTarget": { # HTTP target. When specified at the Queue level, all tasks with HttpRequest are overridden according to the target. # Modifies HTTP target for HTTP tasks.
"headerOverrides": [ # HTTP target headers. This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask. These headers represent a subset of the headers that will be configured for the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example,`Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. The default value is set to "application/json"`. * User-Agent: This will be set to `"Google-Cloud-Tasks"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
{ # Wraps the Header object.
"header": { # Defines a header message. A header can have a key and a value. # Header embodying a key and a value. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
@@ -419,7 +419,7 @@ Method Details
"service": "A String", # App service. By default, the task is sent to the service which is the default service when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
"version": "A String", # App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
},
- "httpTarget": { # HTTP target. When specified as a Queue, all the tasks with [HttpRequest] will be overridden according to the target. # Modifies HTTP target for HTTP tasks.
+ "httpTarget": { # HTTP target. When specified at the Queue level, all tasks with HttpRequest are overridden according to the target. # Modifies HTTP target for HTTP tasks.
"headerOverrides": [ # HTTP target headers. This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask. These headers represent a subset of the headers that will be configured for the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example,`Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. The default value is set to "application/json"`. * User-Agent: This will be set to `"Google-Cloud-Tasks"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
{ # Wraps the Header object.
"header": { # Defines a header message. A header can have a key and a value. # Header embodying a key and a value. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
@@ -503,7 +503,7 @@ Method Details
"service": "A String", # App service. By default, the task is sent to the service which is the default service when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
"version": "A String", # App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
},
- "httpTarget": { # HTTP target. When specified as a Queue, all the tasks with [HttpRequest] will be overridden according to the target. # Modifies HTTP target for HTTP tasks.
+ "httpTarget": { # HTTP target. When specified at the Queue level, all tasks with HttpRequest are overridden according to the target. # Modifies HTTP target for HTTP tasks.
"headerOverrides": [ # HTTP target headers. This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask. These headers represent a subset of the headers that will be configured for the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example,`Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. The default value is set to "application/json"`. * User-Agent: This will be set to `"Google-Cloud-Tasks"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
{ # Wraps the Header object.
"header": { # Defines a header message. A header can have a key and a value. # Header embodying a key and a value. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
@@ -570,7 +570,7 @@ Method Details
"service": "A String", # App service. By default, the task is sent to the service which is the default service when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
"version": "A String", # App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
},
- "httpTarget": { # HTTP target. When specified as a Queue, all the tasks with [HttpRequest] will be overridden according to the target. # Modifies HTTP target for HTTP tasks.
+ "httpTarget": { # HTTP target. When specified at the Queue level, all tasks with HttpRequest are overridden according to the target. # Modifies HTTP target for HTTP tasks.
"headerOverrides": [ # HTTP target headers. This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask. These headers represent a subset of the headers that will be configured for the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example,`Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. The default value is set to "application/json"`. * User-Agent: This will be set to `"Google-Cloud-Tasks"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
{ # Wraps the Header object.
"header": { # Defines a header message. A header can have a key and a value. # Header embodying a key and a value. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
@@ -649,7 +649,7 @@ Method Details
"service": "A String", # App service. By default, the task is sent to the service which is the default service when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
"version": "A String", # App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
},
- "httpTarget": { # HTTP target. When specified as a Queue, all the tasks with [HttpRequest] will be overridden according to the target. # Modifies HTTP target for HTTP tasks.
+ "httpTarget": { # HTTP target. When specified at the Queue level, all tasks with HttpRequest are overridden according to the target. # Modifies HTTP target for HTTP tasks.
"headerOverrides": [ # HTTP target headers. This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask. These headers represent a subset of the headers that will be configured for the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example,`Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. The default value is set to "application/json"`. * User-Agent: This will be set to `"Google-Cloud-Tasks"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
{ # Wraps the Header object.
"header": { # Defines a header message. A header can have a key and a value. # Header embodying a key and a value. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
@@ -728,7 +728,7 @@ Method Details
"service": "A String", # App service. By default, the task is sent to the service which is the default service when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
"version": "A String", # App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
},
- "httpTarget": { # HTTP target. When specified as a Queue, all the tasks with [HttpRequest] will be overridden according to the target. # Modifies HTTP target for HTTP tasks.
+ "httpTarget": { # HTTP target. When specified at the Queue level, all tasks with HttpRequest are overridden according to the target. # Modifies HTTP target for HTTP tasks.
"headerOverrides": [ # HTTP target headers. This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask. These headers represent a subset of the headers that will be configured for the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example,`Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. The default value is set to "application/json"`. * User-Agent: This will be set to `"Google-Cloud-Tasks"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
{ # Wraps the Header object.
"header": { # Defines a header message. A header can have a key and a value. # Header embodying a key and a value. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
@@ -807,7 +807,7 @@ Method Details
"service": "A String", # App service. By default, the task is sent to the service which is the default service when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
"version": "A String", # App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
},
- "httpTarget": { # HTTP target. When specified as a Queue, all the tasks with [HttpRequest] will be overridden according to the target. # Modifies HTTP target for HTTP tasks.
+ "httpTarget": { # HTTP target. When specified at the Queue level, all tasks with HttpRequest are overridden according to the target. # Modifies HTTP target for HTTP tasks.
"headerOverrides": [ # HTTP target headers. This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask. These headers represent a subset of the headers that will be configured for the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example,`Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. The default value is set to "application/json"`. * User-Agent: This will be set to `"Google-Cloud-Tasks"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
{ # Wraps the Header object.
"header": { # Defines a header message. A header can have a key and a value. # Header embodying a key and a value. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
diff --git a/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.html b/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.html
index 900f49b3c4..2ffb335e92 100644
--- a/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.html
+++ b/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.html
@@ -142,7 +142,7 @@ Method Details
"version": "A String", # App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
},
},
- "httpTarget": { # HTTP target. When specified as a Queue, all the tasks with [HttpRequest] will be overridden according to the target. # An http_target is used to override the target values for HTTP tasks.
+ "httpTarget": { # HTTP target. When specified at the Queue level, all tasks with HttpRequest are overridden according to the target. # An http_target is used to override the target values for HTTP tasks.
"headerOverrides": [ # HTTP target headers. This map contains the header field names and values. Headers will be set when running the task is created and/or task is created. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Any header that is prefixed with "X-CloudTasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to `"Google-CloudTasks"`. * `X-Google-*`: Google use only. * `X-AppEngine-*`: Google use only. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example, `Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
{ # Wraps the Header object.
"header": { # Defines a header message. A header can have a key and a value. # Header embodying a key and a value. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
@@ -219,7 +219,7 @@ Method Details
"version": "A String", # App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
},
},
- "httpTarget": { # HTTP target. When specified as a Queue, all the tasks with [HttpRequest] will be overridden according to the target. # An http_target is used to override the target values for HTTP tasks.
+ "httpTarget": { # HTTP target. When specified at the Queue level, all tasks with HttpRequest are overridden according to the target. # An http_target is used to override the target values for HTTP tasks.
"headerOverrides": [ # HTTP target headers. This map contains the header field names and values. Headers will be set when running the task is created and/or task is created. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Any header that is prefixed with "X-CloudTasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to `"Google-CloudTasks"`. * `X-Google-*`: Google use only. * `X-AppEngine-*`: Google use only. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example, `Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
{ # Wraps the Header object.
"header": { # Defines a header message. A header can have a key and a value. # Header embodying a key and a value. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
@@ -322,7 +322,7 @@ Method Details
"version": "A String", # App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
},
},
- "httpTarget": { # HTTP target. When specified as a Queue, all the tasks with [HttpRequest] will be overridden according to the target. # An http_target is used to override the target values for HTTP tasks.
+ "httpTarget": { # HTTP target. When specified at the Queue level, all tasks with HttpRequest are overridden according to the target. # An http_target is used to override the target values for HTTP tasks.
"headerOverrides": [ # HTTP target headers. This map contains the header field names and values. Headers will be set when running the task is created and/or task is created. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Any header that is prefixed with "X-CloudTasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to `"Google-CloudTasks"`. * `X-Google-*`: Google use only. * `X-AppEngine-*`: Google use only. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example, `Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
{ # Wraps the Header object.
"header": { # Defines a header message. A header can have a key and a value. # Header embodying a key and a value. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
@@ -456,7 +456,7 @@ Method Details
"version": "A String", # App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
},
},
- "httpTarget": { # HTTP target. When specified as a Queue, all the tasks with [HttpRequest] will be overridden according to the target. # An http_target is used to override the target values for HTTP tasks.
+ "httpTarget": { # HTTP target. When specified at the Queue level, all tasks with HttpRequest are overridden according to the target. # An http_target is used to override the target values for HTTP tasks.
"headerOverrides": [ # HTTP target headers. This map contains the header field names and values. Headers will be set when running the task is created and/or task is created. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Any header that is prefixed with "X-CloudTasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to `"Google-CloudTasks"`. * `X-Google-*`: Google use only. * `X-AppEngine-*`: Google use only. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example, `Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
{ # Wraps the Header object.
"header": { # Defines a header message. A header can have a key and a value. # Header embodying a key and a value. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
@@ -551,7 +551,7 @@ Method Details
"version": "A String", # App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
},
},
- "httpTarget": { # HTTP target. When specified as a Queue, all the tasks with [HttpRequest] will be overridden according to the target. # An http_target is used to override the target values for HTTP tasks.
+ "httpTarget": { # HTTP target. When specified at the Queue level, all tasks with HttpRequest are overridden according to the target. # An http_target is used to override the target values for HTTP tasks.
"headerOverrides": [ # HTTP target headers. This map contains the header field names and values. Headers will be set when running the task is created and/or task is created. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Any header that is prefixed with "X-CloudTasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to `"Google-CloudTasks"`. * `X-Google-*`: Google use only. * `X-AppEngine-*`: Google use only. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example, `Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
{ # Wraps the Header object.
"header": { # Defines a header message. A header can have a key and a value. # Header embodying a key and a value. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
@@ -629,7 +629,7 @@ Method Details
"version": "A String", # App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
},
},
- "httpTarget": { # HTTP target. When specified as a Queue, all the tasks with [HttpRequest] will be overridden according to the target. # An http_target is used to override the target values for HTTP tasks.
+ "httpTarget": { # HTTP target. When specified at the Queue level, all tasks with HttpRequest are overridden according to the target. # An http_target is used to override the target values for HTTP tasks.
"headerOverrides": [ # HTTP target headers. This map contains the header field names and values. Headers will be set when running the task is created and/or task is created. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Any header that is prefixed with "X-CloudTasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to `"Google-CloudTasks"`. * `X-Google-*`: Google use only. * `X-AppEngine-*`: Google use only. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example, `Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
{ # Wraps the Header object.
"header": { # Defines a header message. A header can have a key and a value. # Header embodying a key and a value. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
@@ -719,7 +719,7 @@ Method Details
"version": "A String", # App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
},
},
- "httpTarget": { # HTTP target. When specified as a Queue, all the tasks with [HttpRequest] will be overridden according to the target. # An http_target is used to override the target values for HTTP tasks.
+ "httpTarget": { # HTTP target. When specified at the Queue level, all tasks with HttpRequest are overridden according to the target. # An http_target is used to override the target values for HTTP tasks.
"headerOverrides": [ # HTTP target headers. This map contains the header field names and values. Headers will be set when running the task is created and/or task is created. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Any header that is prefixed with "X-CloudTasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to `"Google-CloudTasks"`. * `X-Google-*`: Google use only. * `X-AppEngine-*`: Google use only. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example, `Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
{ # Wraps the Header object.
"header": { # Defines a header message. A header can have a key and a value. # Header embodying a key and a value. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
@@ -809,7 +809,7 @@ Method Details
"version": "A String", # App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
},
},
- "httpTarget": { # HTTP target. When specified as a Queue, all the tasks with [HttpRequest] will be overridden according to the target. # An http_target is used to override the target values for HTTP tasks.
+ "httpTarget": { # HTTP target. When specified at the Queue level, all tasks with HttpRequest are overridden according to the target. # An http_target is used to override the target values for HTTP tasks.
"headerOverrides": [ # HTTP target headers. This map contains the header field names and values. Headers will be set when running the task is created and/or task is created. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Any header that is prefixed with "X-CloudTasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to `"Google-CloudTasks"`. * `X-Google-*`: Google use only. * `X-AppEngine-*`: Google use only. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example, `Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
{ # Wraps the Header object.
"header": { # Defines a header message. A header can have a key and a value. # Header embodying a key and a value. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
@@ -899,7 +899,7 @@ Method Details
"version": "A String", # App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
},
},
- "httpTarget": { # HTTP target. When specified as a Queue, all the tasks with [HttpRequest] will be overridden according to the target. # An http_target is used to override the target values for HTTP tasks.
+ "httpTarget": { # HTTP target. When specified at the Queue level, all tasks with HttpRequest are overridden according to the target. # An http_target is used to override the target values for HTTP tasks.
"headerOverrides": [ # HTTP target headers. This map contains the header field names and values. Headers will be set when running the task is created and/or task is created. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Any header that is prefixed with "X-CloudTasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to `"Google-CloudTasks"`. * `X-Google-*`: Google use only. * `X-AppEngine-*`: Google use only. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example, `Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
{ # Wraps the Header object.
"header": { # Defines a header message. A header can have a key and a value. # Header embodying a key and a value. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
diff --git a/docs/dyn/cloudtasks_v2beta3.projects.locations.queues.html b/docs/dyn/cloudtasks_v2beta3.projects.locations.queues.html
index a3697b1c21..99a48fff3a 100644
--- a/docs/dyn/cloudtasks_v2beta3.projects.locations.queues.html
+++ b/docs/dyn/cloudtasks_v2beta3.projects.locations.queues.html
@@ -142,7 +142,7 @@ Method Details
"version": "A String", # App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
},
},
- "httpTarget": { # HTTP target. When specified as a Queue, all the tasks with [HttpRequest] will be overridden according to the target. # Modifies HTTP target for HTTP tasks.
+ "httpTarget": { # HTTP target. When specified at the Queue level, all tasks with HttpRequest are overridden according to the target. # Modifies HTTP target for HTTP tasks.
"headerOverrides": [ # HTTP target headers. This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask. These headers represent a subset of the headers that will be configured for the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example,`Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. The default value is set to `"application/json"`. * User-Agent: This will be set to `"Google-Cloud-Tasks"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
{ # Wraps the Header object.
"header": { # Defines a header message. A header can have a key and a value. # Header embodying a key and a value. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
@@ -220,7 +220,7 @@ Method Details
"version": "A String", # App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
},
},
- "httpTarget": { # HTTP target. When specified as a Queue, all the tasks with [HttpRequest] will be overridden according to the target. # Modifies HTTP target for HTTP tasks.
+ "httpTarget": { # HTTP target. When specified at the Queue level, all tasks with HttpRequest are overridden according to the target. # Modifies HTTP target for HTTP tasks.
"headerOverrides": [ # HTTP target headers. This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask. These headers represent a subset of the headers that will be configured for the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example,`Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. The default value is set to `"application/json"`. * User-Agent: This will be set to `"Google-Cloud-Tasks"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
{ # Wraps the Header object.
"header": { # Defines a header message. A header can have a key and a value. # Header embodying a key and a value. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
@@ -324,7 +324,7 @@ Method Details
"version": "A String", # App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
},
},
- "httpTarget": { # HTTP target. When specified as a Queue, all the tasks with [HttpRequest] will be overridden according to the target. # Modifies HTTP target for HTTP tasks.
+ "httpTarget": { # HTTP target. When specified at the Queue level, all tasks with HttpRequest are overridden according to the target. # Modifies HTTP target for HTTP tasks.
"headerOverrides": [ # HTTP target headers. This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask. These headers represent a subset of the headers that will be configured for the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example,`Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. The default value is set to `"application/json"`. * User-Agent: This will be set to `"Google-Cloud-Tasks"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
{ # Wraps the Header object.
"header": { # Defines a header message. A header can have a key and a value. # Header embodying a key and a value. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
@@ -459,7 +459,7 @@ Method Details
"version": "A String", # App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
},
},
- "httpTarget": { # HTTP target. When specified as a Queue, all the tasks with [HttpRequest] will be overridden according to the target. # Modifies HTTP target for HTTP tasks.
+ "httpTarget": { # HTTP target. When specified at the Queue level, all tasks with HttpRequest are overridden according to the target. # Modifies HTTP target for HTTP tasks.
"headerOverrides": [ # HTTP target headers. This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask. These headers represent a subset of the headers that will be configured for the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example,`Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. The default value is set to `"application/json"`. * User-Agent: This will be set to `"Google-Cloud-Tasks"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
{ # Wraps the Header object.
"header": { # Defines a header message. A header can have a key and a value. # Header embodying a key and a value. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
@@ -555,7 +555,7 @@ Method Details
"version": "A String", # App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
},
},
- "httpTarget": { # HTTP target. When specified as a Queue, all the tasks with [HttpRequest] will be overridden according to the target. # Modifies HTTP target for HTTP tasks.
+ "httpTarget": { # HTTP target. When specified at the Queue level, all tasks with HttpRequest are overridden according to the target. # Modifies HTTP target for HTTP tasks.
"headerOverrides": [ # HTTP target headers. This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask. These headers represent a subset of the headers that will be configured for the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example,`Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. The default value is set to `"application/json"`. * User-Agent: This will be set to `"Google-Cloud-Tasks"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
{ # Wraps the Header object.
"header": { # Defines a header message. A header can have a key and a value. # Header embodying a key and a value. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
@@ -634,7 +634,7 @@ Method Details
"version": "A String", # App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
},
},
- "httpTarget": { # HTTP target. When specified as a Queue, all the tasks with [HttpRequest] will be overridden according to the target. # Modifies HTTP target for HTTP tasks.
+ "httpTarget": { # HTTP target. When specified at the Queue level, all tasks with HttpRequest are overridden according to the target. # Modifies HTTP target for HTTP tasks.
"headerOverrides": [ # HTTP target headers. This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask. These headers represent a subset of the headers that will be configured for the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example,`Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. The default value is set to `"application/json"`. * User-Agent: This will be set to `"Google-Cloud-Tasks"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
{ # Wraps the Header object.
"header": { # Defines a header message. A header can have a key and a value. # Header embodying a key and a value. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
@@ -725,7 +725,7 @@ Method Details
"version": "A String", # App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
},
},
- "httpTarget": { # HTTP target. When specified as a Queue, all the tasks with [HttpRequest] will be overridden according to the target. # Modifies HTTP target for HTTP tasks.
+ "httpTarget": { # HTTP target. When specified at the Queue level, all tasks with HttpRequest are overridden according to the target. # Modifies HTTP target for HTTP tasks.
"headerOverrides": [ # HTTP target headers. This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask. These headers represent a subset of the headers that will be configured for the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example,`Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. The default value is set to `"application/json"`. * User-Agent: This will be set to `"Google-Cloud-Tasks"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
{ # Wraps the Header object.
"header": { # Defines a header message. A header can have a key and a value. # Header embodying a key and a value. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
@@ -816,7 +816,7 @@ Method Details
"version": "A String", # App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
},
},
- "httpTarget": { # HTTP target. When specified as a Queue, all the tasks with [HttpRequest] will be overridden according to the target. # Modifies HTTP target for HTTP tasks.
+ "httpTarget": { # HTTP target. When specified at the Queue level, all tasks with HttpRequest are overridden according to the target. # Modifies HTTP target for HTTP tasks.
"headerOverrides": [ # HTTP target headers. This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask. These headers represent a subset of the headers that will be configured for the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example,`Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. The default value is set to `"application/json"`. * User-Agent: This will be set to `"Google-Cloud-Tasks"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
{ # Wraps the Header object.
"header": { # Defines a header message. A header can have a key and a value. # Header embodying a key and a value. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
@@ -907,7 +907,7 @@ Method Details
"version": "A String", # App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
},
},
- "httpTarget": { # HTTP target. When specified as a Queue, all the tasks with [HttpRequest] will be overridden according to the target. # Modifies HTTP target for HTTP tasks.
+ "httpTarget": { # HTTP target. When specified at the Queue level, all tasks with HttpRequest are overridden according to the target. # Modifies HTTP target for HTTP tasks.
"headerOverrides": [ # HTTP target headers. This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask. These headers represent a subset of the headers that will be configured for the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example,`Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. The default value is set to `"application/json"`. * User-Agent: This will be set to `"Google-Cloud-Tasks"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
{ # Wraps the Header object.
"header": { # Defines a header message. A header can have a key and a value. # Header embodying a key and a value. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms).
diff --git a/googleapiclient/discovery_cache/documents/cloudtasks.v2.json b/googleapiclient/discovery_cache/documents/cloudtasks.v2.json
index 8f0f7360df..33dc1660d3 100644
--- a/googleapiclient/discovery_cache/documents/cloudtasks.v2.json
+++ b/googleapiclient/discovery_cache/documents/cloudtasks.v2.json
@@ -242,6 +242,35 @@
}
},
"resources": {
+"operations": {
+"methods": {
+"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": "v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "cloudtasks.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": "v2/{+name}",
+"response": {
+"$ref": "Operation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+},
"queues": {
"methods": {
"create": {
@@ -785,7 +814,7 @@
}
}
},
-"revision": "20260609",
+"revision": "20260831",
"rootUrl": "https://cloudtasks.googleapis.com/",
"schemas": {
"AppEngineHttpRequest": {
@@ -1134,7 +1163,7 @@
"type": "object"
},
"HttpTarget": {
-"description": "HTTP target. When specified as a Queue, all the tasks with [HttpRequest] will be overridden according to the target.",
+"description": "HTTP target. When specified at the Queue level, all tasks with HttpRequest are overridden according to the target.",
"id": "HttpTarget",
"properties": {
"headerOverrides": {
@@ -1301,6 +1330,41 @@
},
"type": "object"
},
+"Operation": {
+"description": "This resource represents a long-running operation that is the result of a network API call.",
+"id": "Operation",
+"properties": {
+"done": {
+"description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.",
+"type": "boolean"
+},
+"error": {
+"$ref": "Status",
+"description": "The error result of the operation in case of failure or cancellation."
+},
+"metadata": {
+"additionalProperties": {
+"description": "Properties of the object. Contains field @type with type URL.",
+"type": "any"
+},
+"description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
+"type": "object"
+},
+"name": {
+"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.",
+"type": "string"
+},
+"response": {
+"additionalProperties": {
+"description": "Properties of the object. Contains field @type with type URL.",
+"type": "any"
+},
+"description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.",
+"type": "object"
+}
+},
+"type": "object"
+},
"PathOverride": {
"description": "PathOverride. Path message defines path override for HTTP targets.",
"id": "PathOverride",
diff --git a/googleapiclient/discovery_cache/documents/cloudtasks.v2beta2.json b/googleapiclient/discovery_cache/documents/cloudtasks.v2beta2.json
index deeac74b9b..65b0035ab1 100644
--- a/googleapiclient/discovery_cache/documents/cloudtasks.v2beta2.json
+++ b/googleapiclient/discovery_cache/documents/cloudtasks.v2beta2.json
@@ -1026,7 +1026,7 @@
}
}
},
-"revision": "20260722",
+"revision": "20260831",
"rootUrl": "https://cloudtasks.googleapis.com/",
"schemas": {
"AcknowledgeTaskRequest": {
@@ -1464,7 +1464,7 @@
"type": "object"
},
"HttpTarget": {
-"description": "HTTP target. When specified as a Queue, all the tasks with [HttpRequest] will be overridden according to the target.",
+"description": "HTTP target. When specified at the Queue level, all tasks with HttpRequest are overridden according to the target.",
"id": "HttpTarget",
"properties": {
"headerOverrides": {
diff --git a/googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json b/googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json
index 71529d8961..175a1a29d5 100644
--- a/googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json
+++ b/googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json
@@ -882,7 +882,7 @@
}
}
},
-"revision": "20260722",
+"revision": "20260831",
"rootUrl": "https://cloudtasks.googleapis.com/",
"schemas": {
"AppEngineHttpQueue": {
@@ -1282,7 +1282,7 @@
"type": "object"
},
"HttpTarget": {
-"description": "HTTP target. When specified as a Queue, all the tasks with [HttpRequest] will be overridden according to the target.",
+"description": "HTTP target. When specified at the Queue level, all tasks with HttpRequest are overridden according to the target.",
"id": "HttpTarget",
"properties": {
"headerOverrides": {
From 2903bc32883c7a004d411458ae2f867bb1f6784e Mon Sep 17 00:00:00 2001
From: Yoshi Automation
Date: Tue, 8 Sep 2026 07:20:13 +0000
Subject: [PATCH 15/40] feat(compute): update the api
#### compute:alpha
The following keys were added:
- schemas.BackendService.properties.networkAttachment.type (Total Keys: 1)
- schemas.BackendService.properties.serviceClassId.type (Total Keys: 1)
- schemas.DynamicCompressionPolicy (Total Keys: 3)
- schemas.ForwardingRule.properties.networkAttachment.type (Total Keys: 1)
- schemas.ForwardingRule.properties.serviceClassId.type (Total Keys: 1)
- schemas.HttpRouteAction.properties.dynamicCompressionPolicy.$ref (Total Keys: 1)
- schemas.Network.properties.additionalTags (Total Keys: 3)
- schemas.ResourceStatusPhysicalHostTopology.properties.machine (Total Keys: 2)
#### compute:beta
The following keys were added:
- resources.advice.methods.calendarModeExtension (Total Keys: 16)
- resources.regionSslPolicies.methods.getIamPolicy (Total Keys: 22)
- resources.regionSslPolicies.methods.setIamPolicy (Total Keys: 20)
- resources.sslPolicies.methods.getIamPolicy (Total Keys: 18)
- resources.sslPolicies.methods.setIamPolicy (Total Keys: 16)
- schemas.AliasIpRange.properties.candidateSubnetworkRangeNames (Total Keys: 2)
- schemas.AliasIpRange.properties.effectiveSubnetworkRangeName (Total Keys: 2)
- schemas.CalendarModeExtensionAdviceRequest (Total Keys: 5)
- schemas.CalendarModeExtensionAdviceResponse (Total Keys: 10)
- schemas.DynamicCompressionPolicy (Total Keys: 3)
- schemas.HttpRouteAction.properties.dynamicCompressionPolicy.$ref (Total Keys: 1)
- schemas.InstancePropertiesPatch.properties.exposeHostTopology.type (Total Keys: 1)
- schemas.InterconnectMacsec.properties.interconnectKeyGroup.type (Total Keys: 1)
- schemas.ResourceStatusPhysicalHostTopology.properties.machine (Total Keys: 2)
- schemas.Scheduling.properties.exposeHostTopology.type (Total Keys: 1)
---
docs/dyn/compute_alpha.advice.html | 50 +-
docs/dyn/compute_alpha.backendServices.html | 70 +-
docs/dyn/compute_alpha.forwardingRules.html | 25 +
.../compute_alpha.globalForwardingRules.html | 20 +
docs/dyn/compute_alpha.instances.html | 10 +
docs/dyn/compute_alpha.networks.html | 12 +
.../compute_alpha.regionBackendServices.html | 60 +-
docs/dyn/compute_alpha.regionUrlMaps.html | 120 ++
docs/dyn/compute_alpha.urlMaps.html | 140 ++
docs/dyn/compute_beta.advice.html | 54 +
docs/dyn/compute_beta.backendServices.html | 21 +-
.../compute_beta.instanceGroupManagers.html | 6 +
docs/dyn/compute_beta.instanceTemplates.html | 80 ++
docs/dyn/compute_beta.instances.html | 168 +++
docs/dyn/compute_beta.interconnects.html | 12 +
docs/dyn/compute_beta.machineImages.html | 120 ++
.../compute_beta.regionBackendServices.html | 18 +-
...pute_beta.regionInstanceGroupManagers.html | 5 +
.../compute_beta.regionInstanceTemplates.html | 60 +
docs/dyn/compute_beta.regionInstances.html | 20 +
docs/dyn/compute_beta.regionSslPolicies.html | 1250 +++++++++++++++++
docs/dyn/compute_beta.regionUrlMaps.html | 120 ++
docs/dyn/compute_beta.sslPolicies.html | 1248 ++++++++++++++++
docs/dyn/compute_beta.urlMaps.html | 140 ++
.../documents/compute.alpha.json | 82 +-
.../documents/compute.beta.json | 332 ++++-
26 files changed, 4174 insertions(+), 69 deletions(-)
diff --git a/docs/dyn/compute_alpha.advice.html b/docs/dyn/compute_alpha.advice.html
index 1641405106..2dd2e86fd7 100644
--- a/docs/dyn/compute_alpha.advice.html
+++ b/docs/dyn/compute_alpha.advice.html
@@ -79,7 +79,7 @@ Instance Methods
Advise how, where and when to create the requested amount of instances
calendarModeExtension(project, region, body=None, x__xgafv=None)
-Advise on whether extending an existing Future Reservation is possible
+Advises on whether extending an existing future reservation is possible
capacity(project, region, body=None, x__xgafv=None)
Advice on making real-time decisions (such as choosing zone or
@@ -214,10 +214,10 @@ Method Details
calendarModeExtension(project, region, body=None, x__xgafv=None)
- Advise on whether extending an existing Future Reservation is possible
-based on the desired extension end time. If capacity is not available for
-the entire requested duration, the method will recommend the longest
-possible extension.
+ Advises on whether extending an existing future reservation is possible
+based on the desired extension end time. If capacity isn't available for
+the entire requested duration, the method recommends the longest possible
+extension.
Args:
project: string, Project ID for this request. (required)
@@ -225,11 +225,11 @@ Method Details
body: object, The request body.
The object takes the form of:
-{ # A request to recommend the best duration for extending an existing
- # Future Reservation in CALENDAR mode, that is equal or less than the specified
- # extension duration.
- "endTimeNotLaterThan": "A String", # Required. The desired end time after the Future Reservation is extended.
- "futureReservation": "A String", # Required. Reference to the Future Reservation, in the format:
+{ # A request to recommend the maximum duration for extending an existing future
+ # reservation in calendar mode. The recommended duration is shorter than or
+ # equal to the specified extension duration.
+ "endTimeNotLaterThan": "A String", # Required. The desired end time for the extension.
+ "futureReservation": "A String", # Required. Reference to the future reservation, in the format:
# projects/{project}/zones/{zone}/futureReservations/{name}
# Full URIs that include hostnames (like compute.googleapis.com or
# www.googleapis.com) are also supported.
@@ -243,23 +243,23 @@ Method Details
Returns:
An object of the form:
- { # A response containing the recommended duration to extend a
- # Future Reservation in CALENDAR mode based on the available capacity during
- # the extension period.
- "endTime": "A String", # The recommended end time for the extension, which will either be
- # the end time requested by the caller or the longest alternative for
- # which there is sufficient capacity. If extension is not possible, this
- # field will be empty, and not_recommended_reason will be populated instead.
- "notRecommendedReason": { # Information about why no recommendation was provided. # Information regarding the reason why the Future Reservation
- # cannot be extended at all. If a recommendation is provided, whether that is
- # the requested end time or an alternative, this field will be empty.
- "details": "A String", # Details (human readable) describing why the recommendation
- # was not provided. For example, if the status is CONDITION_NOT_MET,
- # then this field will contain information about why the requested
- # extension duration is not eligible.
+ { # A response that contains the recommended duration for extending
+ # a future reservation in calendar mode based on available capacity
+ # during the extension period.
+ "endTime": "A String", # The recommended end time for the extension, which is either the end time
+ # requested by the caller or the longest alternative with sufficient
+ # capacity. If the extension is not possible, this field is empty, and
+ # notRecommendedReason is populated instead.
+ "notRecommendedReason": { # Information about why no recommendation was provided. # The reason why the future reservation can't be extended. If a
+ # recommendation is provided, whether for the requested end time or an
+ # alternative, this field is empty.
+ "details": "A String", # Human-readable details describing why the recommendation wasn't provided.
+ # For example, if the status is CONDITIONS_NOT_MET, this field explains why
+ # the requested extension duration isn't possible.
"status": "A String", # Status of recommendation.
},
- "recommendationId": "A String", # Unique id of the recommendation, a UUID string generated by the API.
+ "recommendationId": "A String", # The unique ID of the recommendation, which is a UUID string generated by
+ # the API.
}
diff --git a/docs/dyn/compute_alpha.backendServices.html b/docs/dyn/compute_alpha.backendServices.html
index d918170eee..9f79bff479 100644
--- a/docs/dyn/compute_alpha.backendServices.html
+++ b/docs/dyn/compute_alpha.backendServices.html
@@ -1315,7 +1315,8 @@ Method Details
# instance must already be attached to the NEG specified in the
# haPolicy.leader.backendGroup.
#
- # The name must be 1-63 characters long, and comply with RFC1035.
+ # The value must be a valid RFC1035 name (1-63 characters) or a valid
+ # instance URL.
# Authorization requires the following IAM permission on the
# specified resource instance: compute.instances.use
},
@@ -1578,6 +1579,8 @@ Method Details
# Balancers when the haPolicy fastIpMove is enabled.
#
# This field can only be specified when the load balancing scheme is set toINTERNAL, or when the load balancing scheme is set toEXTERNAL and haPolicy fastIpMove is enabled.
+ "networkAttachment": "A String", # Optional. The URL of the network attachment that this resource
+ # belongs to.projects/{project}/regions/{region_name}/networkAttachments/{network_attachment_name}.
"networkPassThroughLbTrafficPolicy": { # Configures traffic steering properties of internal passthrough Network
# Load Balancers.
#
@@ -2224,6 +2227,11 @@ Method Details
# If set, lists of backends and health checks must be both empty.
"A String",
],
+ "serviceClassId": "A String", # Optional. The service class ID associated with this resource.
+ # Producer Service's Service class ID for the region of this backend
+ # service. Can only be used with network_attachment. It is not possible to
+ # use on its own; however, network_attachment can be used without
+ # service_class_id.
"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource.
#
# Can only be set if load balancing scheme is EXTERNAL_MANAGED,
@@ -3831,7 +3839,8 @@ Method Details
# instance must already be attached to the NEG specified in the
# haPolicy.leader.backendGroup.
#
- # The name must be 1-63 characters long, and comply with RFC1035.
+ # The value must be a valid RFC1035 name (1-63 characters) or a valid
+ # instance URL.
# Authorization requires the following IAM permission on the
# specified resource instance: compute.instances.use
},
@@ -4094,6 +4103,8 @@ Method Details
# Balancers when the haPolicy fastIpMove is enabled.
#
# This field can only be specified when the load balancing scheme is set toINTERNAL, or when the load balancing scheme is set toEXTERNAL and haPolicy fastIpMove is enabled.
+ "networkAttachment": "A String", # Optional. The URL of the network attachment that this resource
+ # belongs to.projects/{project}/regions/{region_name}/networkAttachments/{network_attachment_name}.
"networkPassThroughLbTrafficPolicy": { # Configures traffic steering properties of internal passthrough Network
# Load Balancers.
#
@@ -4740,6 +4751,11 @@ Method Details
# If set, lists of backends and health checks must be both empty.
"A String",
],
+ "serviceClassId": "A String", # Optional. The service class ID associated with this resource.
+ # Producer Service's Service class ID for the region of this backend
+ # service. Can only be used with network_attachment. It is not possible to
+ # use on its own; however, network_attachment can be used without
+ # service_class_id.
"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource.
#
# Can only be set if load balancing scheme is EXTERNAL_MANAGED,
@@ -6839,7 +6855,8 @@ Method Details
# instance must already be attached to the NEG specified in the
# haPolicy.leader.backendGroup.
#
- # The name must be 1-63 characters long, and comply with RFC1035.
+ # The value must be a valid RFC1035 name (1-63 characters) or a valid
+ # instance URL.
# Authorization requires the following IAM permission on the
# specified resource instance: compute.instances.use
},
@@ -7102,6 +7119,8 @@ Method Details
# Balancers when the haPolicy fastIpMove is enabled.
#
# This field can only be specified when the load balancing scheme is set toINTERNAL, or when the load balancing scheme is set toEXTERNAL and haPolicy fastIpMove is enabled.
+ "networkAttachment": "A String", # Optional. The URL of the network attachment that this resource
+ # belongs to.projects/{project}/regions/{region_name}/networkAttachments/{network_attachment_name}.
"networkPassThroughLbTrafficPolicy": { # Configures traffic steering properties of internal passthrough Network
# Load Balancers.
#
@@ -7748,6 +7767,11 @@ Method Details
# If set, lists of backends and health checks must be both empty.
"A String",
],
+ "serviceClassId": "A String", # Optional. The service class ID associated with this resource.
+ # Producer Service's Service class ID for the region of this backend
+ # service. Can only be used with network_attachment. It is not possible to
+ # use on its own; however, network_attachment can be used without
+ # service_class_id.
"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource.
#
# Can only be set if load balancing scheme is EXTERNAL_MANAGED,
@@ -9036,7 +9060,8 @@ Method Details
# instance must already be attached to the NEG specified in the
# haPolicy.leader.backendGroup.
#
- # The name must be 1-63 characters long, and comply with RFC1035.
+ # The value must be a valid RFC1035 name (1-63 characters) or a valid
+ # instance URL.
# Authorization requires the following IAM permission on the
# specified resource instance: compute.instances.use
},
@@ -9299,6 +9324,8 @@ Method Details
# Balancers when the haPolicy fastIpMove is enabled.
#
# This field can only be specified when the load balancing scheme is set toINTERNAL, or when the load balancing scheme is set toEXTERNAL and haPolicy fastIpMove is enabled.
+ "networkAttachment": "A String", # Optional. The URL of the network attachment that this resource
+ # belongs to.projects/{project}/regions/{region_name}/networkAttachments/{network_attachment_name}.
"networkPassThroughLbTrafficPolicy": { # Configures traffic steering properties of internal passthrough Network
# Load Balancers.
#
@@ -9945,6 +9972,11 @@ Method Details
# If set, lists of backends and health checks must be both empty.
"A String",
],
+ "serviceClassId": "A String", # Optional. The service class ID associated with this resource.
+ # Producer Service's Service class ID for the region of this backend
+ # service. Can only be used with network_attachment. It is not possible to
+ # use on its own; however, network_attachment can be used without
+ # service_class_id.
"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource.
#
# Can only be set if load balancing scheme is EXTERNAL_MANAGED,
@@ -10967,7 +10999,8 @@ Method Details
# instance must already be attached to the NEG specified in the
# haPolicy.leader.backendGroup.
#
- # The name must be 1-63 characters long, and comply with RFC1035.
+ # The value must be a valid RFC1035 name (1-63 characters) or a valid
+ # instance URL.
# Authorization requires the following IAM permission on the
# specified resource instance: compute.instances.use
},
@@ -11230,6 +11263,8 @@ Method Details
# Balancers when the haPolicy fastIpMove is enabled.
#
# This field can only be specified when the load balancing scheme is set toINTERNAL, or when the load balancing scheme is set toEXTERNAL and haPolicy fastIpMove is enabled.
+ "networkAttachment": "A String", # Optional. The URL of the network attachment that this resource
+ # belongs to.projects/{project}/regions/{region_name}/networkAttachments/{network_attachment_name}.
"networkPassThroughLbTrafficPolicy": { # Configures traffic steering properties of internal passthrough Network
# Load Balancers.
#
@@ -11876,6 +11911,11 @@ Method Details
# If set, lists of backends and health checks must be both empty.
"A String",
],
+ "serviceClassId": "A String", # Optional. The service class ID associated with this resource.
+ # Producer Service's Service class ID for the region of this backend
+ # service. Can only be used with network_attachment. It is not possible to
+ # use on its own; however, network_attachment can be used without
+ # service_class_id.
"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource.
#
# Can only be set if load balancing scheme is EXTERNAL_MANAGED,
@@ -12838,7 +12878,8 @@ Method Details
# instance must already be attached to the NEG specified in the
# haPolicy.leader.backendGroup.
#
- # The name must be 1-63 characters long, and comply with RFC1035.
+ # The value must be a valid RFC1035 name (1-63 characters) or a valid
+ # instance URL.
# Authorization requires the following IAM permission on the
# specified resource instance: compute.instances.use
},
@@ -13101,6 +13142,8 @@ Method Details
# Balancers when the haPolicy fastIpMove is enabled.
#
# This field can only be specified when the load balancing scheme is set toINTERNAL, or when the load balancing scheme is set toEXTERNAL and haPolicy fastIpMove is enabled.
+ "networkAttachment": "A String", # Optional. The URL of the network attachment that this resource
+ # belongs to.projects/{project}/regions/{region_name}/networkAttachments/{network_attachment_name}.
"networkPassThroughLbTrafficPolicy": { # Configures traffic steering properties of internal passthrough Network
# Load Balancers.
#
@@ -13747,6 +13790,11 @@ Method Details
# If set, lists of backends and health checks must be both empty.
"A String",
],
+ "serviceClassId": "A String", # Optional. The service class ID associated with this resource.
+ # Producer Service's Service class ID for the region of this backend
+ # service. Can only be used with network_attachment. It is not possible to
+ # use on its own; however, network_attachment can be used without
+ # service_class_id.
"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource.
#
# Can only be set if load balancing scheme is EXTERNAL_MANAGED,
@@ -16491,7 +16539,8 @@ Method Details
# instance must already be attached to the NEG specified in the
# haPolicy.leader.backendGroup.
#
- # The name must be 1-63 characters long, and comply with RFC1035.
+ # The value must be a valid RFC1035 name (1-63 characters) or a valid
+ # instance URL.
# Authorization requires the following IAM permission on the
# specified resource instance: compute.instances.use
},
@@ -16754,6 +16803,8 @@ Method Details
# Balancers when the haPolicy fastIpMove is enabled.
#
# This field can only be specified when the load balancing scheme is set toINTERNAL, or when the load balancing scheme is set toEXTERNAL and haPolicy fastIpMove is enabled.
+ "networkAttachment": "A String", # Optional. The URL of the network attachment that this resource
+ # belongs to.projects/{project}/regions/{region_name}/networkAttachments/{network_attachment_name}.
"networkPassThroughLbTrafficPolicy": { # Configures traffic steering properties of internal passthrough Network
# Load Balancers.
#
@@ -17400,6 +17451,11 @@ Method Details
# If set, lists of backends and health checks must be both empty.
"A String",
],
+ "serviceClassId": "A String", # Optional. The service class ID associated with this resource.
+ # Producer Service's Service class ID for the region of this backend
+ # service. Can only be used with network_attachment. It is not possible to
+ # use on its own; however, network_attachment can be used without
+ # service_class_id.
"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource.
#
# Can only be set if load balancing scheme is EXTERNAL_MANAGED,
diff --git a/docs/dyn/compute_alpha.forwardingRules.html b/docs/dyn/compute_alpha.forwardingRules.html
index bb8ff46531..450610a25d 100644
--- a/docs/dyn/compute_alpha.forwardingRules.html
+++ b/docs/dyn/compute_alpha.forwardingRules.html
@@ -598,6 +598,8 @@ Method Details
#
# For Private Service Connect forwarding rules that forward traffic to Google
# APIs, a network must be provided.
+ "networkAttachment": "A String", # Optional. The URL of the network attachment that this resource
+ # belongs to.projects/{project}/regions/{region_name}/networkAttachments/{network_attachment_name}.
"networkTier": "A String", # This signifies the networking tier used for configuring
# this load balancer and can only take the following values:PREMIUM, STANDARD.
#
@@ -677,6 +679,9 @@ Method Details
# 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. [Output Only] Server-defined URL for this resource with the resource id.
+ "serviceClassId": "A String", # Optional. Producer Service's Service class ID for the region of this forwarding rule.
+ # Can only be used with network_attachment. It is not possible to use on its
+ # own; however, network_attachment can be used without service_class_id.
"serviceDirectoryRegistrations": [ # Service Directory resources to register this forwarding rule with.
# Currently, only supports a single Service Directory resource.
{ # Describes the auto-registration of the forwarding rule to Service Directory.
@@ -1539,6 +1544,8 @@ Method Details
#
# For Private Service Connect forwarding rules that forward traffic to Google
# APIs, a network must be provided.
+ "networkAttachment": "A String", # Optional. The URL of the network attachment that this resource
+ # belongs to.projects/{project}/regions/{region_name}/networkAttachments/{network_attachment_name}.
"networkTier": "A String", # This signifies the networking tier used for configuring
# this load balancer and can only take the following values:PREMIUM, STANDARD.
#
@@ -1618,6 +1625,9 @@ Method Details
# 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. [Output Only] Server-defined URL for this resource with the resource id.
+ "serviceClassId": "A String", # Optional. Producer Service's Service class ID for the region of this forwarding rule.
+ # Can only be used with network_attachment. It is not possible to use on its
+ # own; however, network_attachment can be used without service_class_id.
"serviceDirectoryRegistrations": [ # Service Directory resources to register this forwarding rule with.
# Currently, only supports a single Service Directory resource.
{ # Describes the auto-registration of the forwarding rule to Service Directory.
@@ -2075,6 +2085,8 @@ Method Details
#
# For Private Service Connect forwarding rules that forward traffic to Google
# APIs, a network must be provided.
+ "networkAttachment": "A String", # Optional. The URL of the network attachment that this resource
+ # belongs to.projects/{project}/regions/{region_name}/networkAttachments/{network_attachment_name}.
"networkTier": "A String", # This signifies the networking tier used for configuring
# this load balancer and can only take the following values:PREMIUM, STANDARD.
#
@@ -2154,6 +2166,9 @@ Method Details
# 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. [Output Only] Server-defined URL for this resource with the resource id.
+ "serviceClassId": "A String", # Optional. Producer Service's Service class ID for the region of this forwarding rule.
+ # Can only be used with network_attachment. It is not possible to use on its
+ # own; however, network_attachment can be used without service_class_id.
"serviceDirectoryRegistrations": [ # Service Directory resources to register this forwarding rule with.
# Currently, only supports a single Service Directory resource.
{ # Describes the auto-registration of the forwarding rule to Service Directory.
@@ -3004,6 +3019,8 @@ Method Details
#
# For Private Service Connect forwarding rules that forward traffic to Google
# APIs, a network must be provided.
+ "networkAttachment": "A String", # Optional. The URL of the network attachment that this resource
+ # belongs to.projects/{project}/regions/{region_name}/networkAttachments/{network_attachment_name}.
"networkTier": "A String", # This signifies the networking tier used for configuring
# this load balancer and can only take the following values:PREMIUM, STANDARD.
#
@@ -3083,6 +3100,9 @@ Method Details
# 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. [Output Only] Server-defined URL for this resource with the resource id.
+ "serviceClassId": "A String", # Optional. Producer Service's Service class ID for the region of this forwarding rule.
+ # Can only be used with network_attachment. It is not possible to use on its
+ # own; however, network_attachment can be used without service_class_id.
"serviceDirectoryRegistrations": [ # Service Directory resources to register this forwarding rule with.
# Currently, only supports a single Service Directory resource.
{ # Describes the auto-registration of the forwarding rule to Service Directory.
@@ -3592,6 +3612,8 @@ Method Details
#
# For Private Service Connect forwarding rules that forward traffic to Google
# APIs, a network must be provided.
+ "networkAttachment": "A String", # Optional. The URL of the network attachment that this resource
+ # belongs to.projects/{project}/regions/{region_name}/networkAttachments/{network_attachment_name}.
"networkTier": "A String", # This signifies the networking tier used for configuring
# this load balancer and can only take the following values:PREMIUM, STANDARD.
#
@@ -3671,6 +3693,9 @@ Method Details
# 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. [Output Only] Server-defined URL for this resource with the resource id.
+ "serviceClassId": "A String", # Optional. Producer Service's Service class ID for the region of this forwarding rule.
+ # Can only be used with network_attachment. It is not possible to use on its
+ # own; however, network_attachment can be used without service_class_id.
"serviceDirectoryRegistrations": [ # Service Directory resources to register this forwarding rule with.
# Currently, only supports a single Service Directory resource.
{ # Describes the auto-registration of the forwarding rule to Service Directory.
diff --git a/docs/dyn/compute_alpha.globalForwardingRules.html b/docs/dyn/compute_alpha.globalForwardingRules.html
index bceeb9c71f..eee1e66c00 100644
--- a/docs/dyn/compute_alpha.globalForwardingRules.html
+++ b/docs/dyn/compute_alpha.globalForwardingRules.html
@@ -814,6 +814,8 @@ Method Details
#
# For Private Service Connect forwarding rules that forward traffic to Google
# APIs, a network must be provided.
+ "networkAttachment": "A String", # Optional. The URL of the network attachment that this resource
+ # belongs to.projects/{project}/regions/{region_name}/networkAttachments/{network_attachment_name}.
"networkTier": "A String", # This signifies the networking tier used for configuring
# this load balancer and can only take the following values:PREMIUM, STANDARD.
#
@@ -893,6 +895,9 @@ Method Details
# 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. [Output Only] Server-defined URL for this resource with the resource id.
+ "serviceClassId": "A String", # Optional. Producer Service's Service class ID for the region of this forwarding rule.
+ # Can only be used with network_attachment. It is not possible to use on its
+ # own; however, network_attachment can be used without service_class_id.
"serviceDirectoryRegistrations": [ # Service Directory resources to register this forwarding rule with.
# Currently, only supports a single Service Directory resource.
{ # Describes the auto-registration of the forwarding rule to Service Directory.
@@ -1349,6 +1354,8 @@ Method Details
#
# For Private Service Connect forwarding rules that forward traffic to Google
# APIs, a network must be provided.
+ "networkAttachment": "A String", # Optional. The URL of the network attachment that this resource
+ # belongs to.projects/{project}/regions/{region_name}/networkAttachments/{network_attachment_name}.
"networkTier": "A String", # This signifies the networking tier used for configuring
# this load balancer and can only take the following values:PREMIUM, STANDARD.
#
@@ -1428,6 +1435,9 @@ Method Details
# 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. [Output Only] Server-defined URL for this resource with the resource id.
+ "serviceClassId": "A String", # Optional. Producer Service's Service class ID for the region of this forwarding rule.
+ # Can only be used with network_attachment. It is not possible to use on its
+ # own; however, network_attachment can be used without service_class_id.
"serviceDirectoryRegistrations": [ # Service Directory resources to register this forwarding rule with.
# Currently, only supports a single Service Directory resource.
{ # Describes the auto-registration of the forwarding rule to Service Directory.
@@ -2277,6 +2287,8 @@ Method Details
#
# For Private Service Connect forwarding rules that forward traffic to Google
# APIs, a network must be provided.
+ "networkAttachment": "A String", # Optional. The URL of the network attachment that this resource
+ # belongs to.projects/{project}/regions/{region_name}/networkAttachments/{network_attachment_name}.
"networkTier": "A String", # This signifies the networking tier used for configuring
# this load balancer and can only take the following values:PREMIUM, STANDARD.
#
@@ -2356,6 +2368,9 @@ Method Details
# 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. [Output Only] Server-defined URL for this resource with the resource id.
+ "serviceClassId": "A String", # Optional. Producer Service's Service class ID for the region of this forwarding rule.
+ # Can only be used with network_attachment. It is not possible to use on its
+ # own; however, network_attachment can be used without service_class_id.
"serviceDirectoryRegistrations": [ # Service Directory resources to register this forwarding rule with.
# Currently, only supports a single Service Directory resource.
{ # Describes the auto-registration of the forwarding rule to Service Directory.
@@ -2864,6 +2879,8 @@ Method Details
#
# For Private Service Connect forwarding rules that forward traffic to Google
# APIs, a network must be provided.
+ "networkAttachment": "A String", # Optional. The URL of the network attachment that this resource
+ # belongs to.projects/{project}/regions/{region_name}/networkAttachments/{network_attachment_name}.
"networkTier": "A String", # This signifies the networking tier used for configuring
# this load balancer and can only take the following values:PREMIUM, STANDARD.
#
@@ -2943,6 +2960,9 @@ Method Details
# 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. [Output Only] Server-defined URL for this resource with the resource id.
+ "serviceClassId": "A String", # Optional. Producer Service's Service class ID for the region of this forwarding rule.
+ # Can only be used with network_attachment. It is not possible to use on its
+ # own; however, network_attachment can be used without service_class_id.
"serviceDirectoryRegistrations": [ # Service Directory resources to register this forwarding rule with.
# Currently, only supports a single Service Directory resource.
{ # Describes the auto-registration of the forwarding rule to Service Directory.
diff --git a/docs/dyn/compute_alpha.instances.html b/docs/dyn/compute_alpha.instances.html
index d5d3326eae..ac07bb49a1 100644
--- a/docs/dyn/compute_alpha.instances.html
+++ b/docs/dyn/compute_alpha.instances.html
@@ -2809,6 +2809,8 @@ Method Details
"host": "A String", # [Output Only] The ID of the host on which the running instance is located.
# Instances on the same host experience the lowest possible network
# latency.
+ "machine": "A String", # Output only. [Output Only] The ID of the machine on which the running instance is
+ # located. It is only populated for machines which have multiple hosts.
"subblock": "A String", # [Output Only] The ID of the sub-block in which the running instance is
# located. Instances in the same sub-block experience lower network latency
# than instances in the same block.
@@ -8708,6 +8710,8 @@ Method Details
"host": "A String", # [Output Only] The ID of the host on which the running instance is located.
# Instances on the same host experience the lowest possible network
# latency.
+ "machine": "A String", # Output only. [Output Only] The ID of the machine on which the running instance is
+ # located. It is only populated for machines which have multiple hosts.
"subblock": "A String", # [Output Only] The ID of the sub-block in which the running instance is
# located. Instances in the same sub-block experience lower network latency
# than instances in the same block.
@@ -12035,6 +12039,8 @@ Method Details
"host": "A String", # [Output Only] The ID of the host on which the running instance is located.
# Instances on the same host experience the lowest possible network
# latency.
+ "machine": "A String", # Output only. [Output Only] The ID of the machine on which the running instance is
+ # located. It is only populated for machines which have multiple hosts.
"subblock": "A String", # [Output Only] The ID of the sub-block in which the running instance is
# located. Instances in the same sub-block experience lower network latency
# than instances in the same block.
@@ -14061,6 +14067,8 @@ Method Details
"host": "A String", # [Output Only] The ID of the host on which the running instance is located.
# Instances on the same host experience the lowest possible network
# latency.
+ "machine": "A String", # Output only. [Output Only] The ID of the machine on which the running instance is
+ # located. It is only populated for machines which have multiple hosts.
"subblock": "A String", # [Output Only] The ID of the sub-block in which the running instance is
# located. Instances in the same sub-block experience lower network latency
# than instances in the same block.
@@ -25446,6 +25454,8 @@ Method Details
"host": "A String", # [Output Only] The ID of the host on which the running instance is located.
# Instances on the same host experience the lowest possible network
# latency.
+ "machine": "A String", # Output only. [Output Only] The ID of the machine on which the running instance is
+ # located. It is only populated for machines which have multiple hosts.
"subblock": "A String", # [Output Only] The ID of the sub-block in which the running instance is
# located. Instances in the same sub-block experience lower network latency
# than instances in the same block.
diff --git a/docs/dyn/compute_alpha.networks.html b/docs/dyn/compute_alpha.networks.html
index 658eb339ba..afcea1be69 100644
--- a/docs/dyn/compute_alpha.networks.html
+++ b/docs/dyn/compute_alpha.networks.html
@@ -1203,6 +1203,9 @@ Method Details
# The range of internal addresses that are legal on this network. This
# range is aCIDR specification, for example:192.168.0.0/16. Provided by the client when the network is
# created.
+ "additionalTags": [ # Output only. [Output Only] Additional tags for this resource.
+ "A String",
+ ],
"autoCreateSubnetworks": True or False, # Must be set to create a VPC network. If not set, a legacy network is
# created.
#
@@ -2493,6 +2496,9 @@ Method Details
# The range of internal addresses that are legal on this network. This
# range is aCIDR specification, for example:192.168.0.0/16. Provided by the client when the network is
# created.
+ "additionalTags": [ # Output only. [Output Only] Additional tags for this resource.
+ "A String",
+ ],
"autoCreateSubnetworks": True or False, # Must be set to create a VPC network. If not set, a legacy network is
# created.
#
@@ -3081,6 +3087,9 @@ Method Details
# The range of internal addresses that are legal on this network. This
# range is aCIDR specification, for example:192.168.0.0/16. Provided by the client when the network is
# created.
+ "additionalTags": [ # Output only. [Output Only] Additional tags for this resource.
+ "A String",
+ ],
"autoCreateSubnetworks": True or False, # Must be set to create a VPC network. If not set, a legacy network is
# created.
#
@@ -3825,6 +3834,9 @@ Method Details
# The range of internal addresses that are legal on this network. This
# range is aCIDR specification, for example:192.168.0.0/16. Provided by the client when the network is
# created.
+ "additionalTags": [ # Output only. [Output Only] Additional tags for this resource.
+ "A String",
+ ],
"autoCreateSubnetworks": True or False, # Must be set to create a VPC network. If not set, a legacy network is
# created.
#
diff --git a/docs/dyn/compute_alpha.regionBackendServices.html b/docs/dyn/compute_alpha.regionBackendServices.html
index e5b0473a80..379a73a175 100644
--- a/docs/dyn/compute_alpha.regionBackendServices.html
+++ b/docs/dyn/compute_alpha.regionBackendServices.html
@@ -1188,7 +1188,8 @@ Method Details
# instance must already be attached to the NEG specified in the
# haPolicy.leader.backendGroup.
#
- # The name must be 1-63 characters long, and comply with RFC1035.
+ # The value must be a valid RFC1035 name (1-63 characters) or a valid
+ # instance URL.
# Authorization requires the following IAM permission on the
# specified resource instance: compute.instances.use
},
@@ -1451,6 +1452,8 @@ Method Details
# Balancers when the haPolicy fastIpMove is enabled.
#
# This field can only be specified when the load balancing scheme is set toINTERNAL, or when the load balancing scheme is set toEXTERNAL and haPolicy fastIpMove is enabled.
+ "networkAttachment": "A String", # Optional. The URL of the network attachment that this resource
+ # belongs to.projects/{project}/regions/{region_name}/networkAttachments/{network_attachment_name}.
"networkPassThroughLbTrafficPolicy": { # Configures traffic steering properties of internal passthrough Network
# Load Balancers.
#
@@ -2097,6 +2100,11 @@ Method Details
# If set, lists of backends and health checks must be both empty.
"A String",
],
+ "serviceClassId": "A String", # Optional. The service class ID associated with this resource.
+ # Producer Service's Service class ID for the region of this backend
+ # service. Can only be used with network_attachment. It is not possible to
+ # use on its own; however, network_attachment can be used without
+ # service_class_id.
"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource.
#
# Can only be set if load balancing scheme is EXTERNAL_MANAGED,
@@ -3419,7 +3427,8 @@ Method Details
# instance must already be attached to the NEG specified in the
# haPolicy.leader.backendGroup.
#
- # The name must be 1-63 characters long, and comply with RFC1035.
+ # The value must be a valid RFC1035 name (1-63 characters) or a valid
+ # instance URL.
# Authorization requires the following IAM permission on the
# specified resource instance: compute.instances.use
},
@@ -3682,6 +3691,8 @@ Method Details
# Balancers when the haPolicy fastIpMove is enabled.
#
# This field can only be specified when the load balancing scheme is set toINTERNAL, or when the load balancing scheme is set toEXTERNAL and haPolicy fastIpMove is enabled.
+ "networkAttachment": "A String", # Optional. The URL of the network attachment that this resource
+ # belongs to.projects/{project}/regions/{region_name}/networkAttachments/{network_attachment_name}.
"networkPassThroughLbTrafficPolicy": { # Configures traffic steering properties of internal passthrough Network
# Load Balancers.
#
@@ -4328,6 +4339,11 @@ Method Details
# If set, lists of backends and health checks must be both empty.
"A String",
],
+ "serviceClassId": "A String", # Optional. The service class ID associated with this resource.
+ # Producer Service's Service class ID for the region of this backend
+ # service. Can only be used with network_attachment. It is not possible to
+ # use on its own; however, network_attachment can be used without
+ # service_class_id.
"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource.
#
# Can only be set if load balancing scheme is EXTERNAL_MANAGED,
@@ -5617,7 +5633,8 @@ Method Details
# instance must already be attached to the NEG specified in the
# haPolicy.leader.backendGroup.
#
- # The name must be 1-63 characters long, and comply with RFC1035.
+ # The value must be a valid RFC1035 name (1-63 characters) or a valid
+ # instance URL.
# Authorization requires the following IAM permission on the
# specified resource instance: compute.instances.use
},
@@ -5880,6 +5897,8 @@ Method Details
# Balancers when the haPolicy fastIpMove is enabled.
#
# This field can only be specified when the load balancing scheme is set toINTERNAL, or when the load balancing scheme is set toEXTERNAL and haPolicy fastIpMove is enabled.
+ "networkAttachment": "A String", # Optional. The URL of the network attachment that this resource
+ # belongs to.projects/{project}/regions/{region_name}/networkAttachments/{network_attachment_name}.
"networkPassThroughLbTrafficPolicy": { # Configures traffic steering properties of internal passthrough Network
# Load Balancers.
#
@@ -6526,6 +6545,11 @@ Method Details
# If set, lists of backends and health checks must be both empty.
"A String",
],
+ "serviceClassId": "A String", # Optional. The service class ID associated with this resource.
+ # Producer Service's Service class ID for the region of this backend
+ # service. Can only be used with network_attachment. It is not possible to
+ # use on its own; however, network_attachment can be used without
+ # service_class_id.
"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource.
#
# Can only be set if load balancing scheme is EXTERNAL_MANAGED,
@@ -7550,7 +7574,8 @@ Method Details
# instance must already be attached to the NEG specified in the
# haPolicy.leader.backendGroup.
#
- # The name must be 1-63 characters long, and comply with RFC1035.
+ # The value must be a valid RFC1035 name (1-63 characters) or a valid
+ # instance URL.
# Authorization requires the following IAM permission on the
# specified resource instance: compute.instances.use
},
@@ -7813,6 +7838,8 @@ Method Details
# Balancers when the haPolicy fastIpMove is enabled.
#
# This field can only be specified when the load balancing scheme is set toINTERNAL, or when the load balancing scheme is set toEXTERNAL and haPolicy fastIpMove is enabled.
+ "networkAttachment": "A String", # Optional. The URL of the network attachment that this resource
+ # belongs to.projects/{project}/regions/{region_name}/networkAttachments/{network_attachment_name}.
"networkPassThroughLbTrafficPolicy": { # Configures traffic steering properties of internal passthrough Network
# Load Balancers.
#
@@ -8459,6 +8486,11 @@ Method Details
# If set, lists of backends and health checks must be both empty.
"A String",
],
+ "serviceClassId": "A String", # Optional. The service class ID associated with this resource.
+ # Producer Service's Service class ID for the region of this backend
+ # service. Can only be used with network_attachment. It is not possible to
+ # use on its own; however, network_attachment can be used without
+ # service_class_id.
"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource.
#
# Can only be set if load balancing scheme is EXTERNAL_MANAGED,
@@ -9422,7 +9454,8 @@ Method Details
# instance must already be attached to the NEG specified in the
# haPolicy.leader.backendGroup.
#
- # The name must be 1-63 characters long, and comply with RFC1035.
+ # The value must be a valid RFC1035 name (1-63 characters) or a valid
+ # instance URL.
# Authorization requires the following IAM permission on the
# specified resource instance: compute.instances.use
},
@@ -9685,6 +9718,8 @@ Method Details
# Balancers when the haPolicy fastIpMove is enabled.
#
# This field can only be specified when the load balancing scheme is set toINTERNAL, or when the load balancing scheme is set toEXTERNAL and haPolicy fastIpMove is enabled.
+ "networkAttachment": "A String", # Optional. The URL of the network attachment that this resource
+ # belongs to.projects/{project}/regions/{region_name}/networkAttachments/{network_attachment_name}.
"networkPassThroughLbTrafficPolicy": { # Configures traffic steering properties of internal passthrough Network
# Load Balancers.
#
@@ -10331,6 +10366,11 @@ Method Details
# If set, lists of backends and health checks must be both empty.
"A String",
],
+ "serviceClassId": "A String", # Optional. The service class ID associated with this resource.
+ # Producer Service's Service class ID for the region of this backend
+ # service. Can only be used with network_attachment. It is not possible to
+ # use on its own; however, network_attachment can be used without
+ # service_class_id.
"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource.
#
# Can only be set if load balancing scheme is EXTERNAL_MANAGED,
@@ -12762,7 +12802,8 @@ Method Details
# instance must already be attached to the NEG specified in the
# haPolicy.leader.backendGroup.
#
- # The name must be 1-63 characters long, and comply with RFC1035.
+ # The value must be a valid RFC1035 name (1-63 characters) or a valid
+ # instance URL.
# Authorization requires the following IAM permission on the
# specified resource instance: compute.instances.use
},
@@ -13025,6 +13066,8 @@ Method Details
# Balancers when the haPolicy fastIpMove is enabled.
#
# This field can only be specified when the load balancing scheme is set toINTERNAL, or when the load balancing scheme is set toEXTERNAL and haPolicy fastIpMove is enabled.
+ "networkAttachment": "A String", # Optional. The URL of the network attachment that this resource
+ # belongs to.projects/{project}/regions/{region_name}/networkAttachments/{network_attachment_name}.
"networkPassThroughLbTrafficPolicy": { # Configures traffic steering properties of internal passthrough Network
# Load Balancers.
#
@@ -13671,6 +13714,11 @@ Method Details
# If set, lists of backends and health checks must be both empty.
"A String",
],
+ "serviceClassId": "A String", # Optional. The service class ID associated with this resource.
+ # Producer Service's Service class ID for the region of this backend
+ # service. Can only be used with network_attachment. It is not possible to
+ # use on its own; however, network_attachment can be used without
+ # service_class_id.
"serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource.
#
# Can only be set if load balancing scheme is EXTERNAL_MANAGED,
diff --git a/docs/dyn/compute_alpha.regionUrlMaps.html b/docs/dyn/compute_alpha.regionUrlMaps.html
index 617fb1ec1e..e11bc1f00e 100644
--- a/docs/dyn/compute_alpha.regionUrlMaps.html
+++ b/docs/dyn/compute_alpha.regionUrlMaps.html
@@ -831,6 +831,11 @@ Method Details
# seconds. This field translates to the Access-Control-Max-Age
# header.
},
+ "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for
+ # Global EXTERNAL_MANAGED load balancer schemes.
+ "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on
+ # the client's Accept-Encoding header.
+ },
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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
@@ -1716,6 +1721,11 @@ Method Details
# seconds. This field translates to the Access-Control-Max-Age
# header.
},
+ "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for
+ # Global EXTERNAL_MANAGED load balancer schemes.
+ "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on
+ # the client's Accept-Encoding header.
+ },
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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
@@ -2582,6 +2592,11 @@ Method Details
# seconds. This field translates to the Access-Control-Max-Age
# header.
},
+ "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for
+ # Global EXTERNAL_MANAGED load balancer schemes.
+ "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on
+ # the client's Accept-Encoding header.
+ },
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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
@@ -3710,6 +3725,11 @@ Method Details
# seconds. This field translates to the Access-Control-Max-Age
# header.
},
+ "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for
+ # Global EXTERNAL_MANAGED load balancer schemes.
+ "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on
+ # the client's Accept-Encoding header.
+ },
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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
@@ -4601,6 +4621,11 @@ Method Details
# seconds. This field translates to the Access-Control-Max-Age
# header.
},
+ "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for
+ # Global EXTERNAL_MANAGED load balancer schemes.
+ "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on
+ # the client's Accept-Encoding header.
+ },
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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
@@ -5486,6 +5511,11 @@ Method Details
# seconds. This field translates to the Access-Control-Max-Age
# header.
},
+ "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for
+ # Global EXTERNAL_MANAGED load balancer schemes.
+ "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on
+ # the client's Accept-Encoding header.
+ },
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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
@@ -6352,6 +6382,11 @@ Method Details
# seconds. This field translates to the Access-Control-Max-Age
# header.
},
+ "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for
+ # Global EXTERNAL_MANAGED load balancer schemes.
+ "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on
+ # the client's Accept-Encoding header.
+ },
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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
@@ -7480,6 +7515,11 @@ Method Details
# seconds. This field translates to the Access-Control-Max-Age
# header.
},
+ "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for
+ # Global EXTERNAL_MANAGED load balancer schemes.
+ "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on
+ # the client's Accept-Encoding header.
+ },
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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
@@ -9091,6 +9131,11 @@ Method Details
# seconds. This field translates to the Access-Control-Max-Age
# header.
},
+ "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for
+ # Global EXTERNAL_MANAGED load balancer schemes.
+ "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on
+ # the client's Accept-Encoding header.
+ },
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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
@@ -9976,6 +10021,11 @@ Method Details
# seconds. This field translates to the Access-Control-Max-Age
# header.
},
+ "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for
+ # Global EXTERNAL_MANAGED load balancer schemes.
+ "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on
+ # the client's Accept-Encoding header.
+ },
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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
@@ -10842,6 +10892,11 @@ Method Details
# seconds. This field translates to the Access-Control-Max-Age
# header.
},
+ "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for
+ # Global EXTERNAL_MANAGED load balancer schemes.
+ "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on
+ # the client's Accept-Encoding header.
+ },
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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
@@ -11970,6 +12025,11 @@ Method Details
# seconds. This field translates to the Access-Control-Max-Age
# header.
},
+ "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for
+ # Global EXTERNAL_MANAGED load balancer schemes.
+ "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on
+ # the client's Accept-Encoding header.
+ },
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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
@@ -12912,6 +12972,11 @@ Method Details
# seconds. This field translates to the Access-Control-Max-Age
# header.
},
+ "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for
+ # Global EXTERNAL_MANAGED load balancer schemes.
+ "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on
+ # the client's Accept-Encoding header.
+ },
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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
@@ -13797,6 +13862,11 @@ Method Details
# seconds. This field translates to the Access-Control-Max-Age
# header.
},
+ "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for
+ # Global EXTERNAL_MANAGED load balancer schemes.
+ "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on
+ # the client's Accept-Encoding header.
+ },
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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
@@ -14663,6 +14733,11 @@ Method Details
# seconds. This field translates to the Access-Control-Max-Age
# header.
},
+ "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for
+ # Global EXTERNAL_MANAGED load balancer schemes.
+ "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on
+ # the client's Accept-Encoding header.
+ },
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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
@@ -15791,6 +15866,11 @@ Method Details
# seconds. This field translates to the Access-Control-Max-Age
# header.
},
+ "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for
+ # Global EXTERNAL_MANAGED load balancer schemes.
+ "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on
+ # the client's Accept-Encoding header.
+ },
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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
@@ -17008,6 +17088,11 @@ Method Details
# seconds. This field translates to the Access-Control-Max-Age
# header.
},
+ "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for
+ # Global EXTERNAL_MANAGED load balancer schemes.
+ "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on
+ # the client's Accept-Encoding header.
+ },
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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
@@ -17893,6 +17978,11 @@ Method Details
# seconds. This field translates to the Access-Control-Max-Age
# header.
},
+ "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for
+ # Global EXTERNAL_MANAGED load balancer schemes.
+ "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on
+ # the client's Accept-Encoding header.
+ },
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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
@@ -18759,6 +18849,11 @@ Method Details
# seconds. This field translates to the Access-Control-Max-Age
# header.
},
+ "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for
+ # Global EXTERNAL_MANAGED load balancer schemes.
+ "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on
+ # the client's Accept-Encoding header.
+ },
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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
@@ -19887,6 +19982,11 @@ Method Details
# seconds. This field translates to the Access-Control-Max-Age
# header.
},
+ "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for
+ # Global EXTERNAL_MANAGED load balancer schemes.
+ "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on
+ # the client's Accept-Encoding header.
+ },
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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
@@ -21072,6 +21172,11 @@ Method Details
# seconds. This field translates to the Access-Control-Max-Age
# header.
},
+ "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for
+ # Global EXTERNAL_MANAGED load balancer schemes.
+ "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on
+ # the client's Accept-Encoding header.
+ },
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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
@@ -21957,6 +22062,11 @@ Method Details
# seconds. This field translates to the Access-Control-Max-Age
# header.
},
+ "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for
+ # Global EXTERNAL_MANAGED load balancer schemes.
+ "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on
+ # the client's Accept-Encoding header.
+ },
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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
@@ -22823,6 +22933,11 @@ Method Details
# seconds. This field translates to the Access-Control-Max-Age
# header.
},
+ "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for
+ # Global EXTERNAL_MANAGED load balancer schemes.
+ "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on
+ # the client's Accept-Encoding header.
+ },
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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
@@ -23951,6 +24066,11 @@ Method Details
# seconds. This field translates to the Access-Control-Max-Age
# header.
},
+ "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for
+ # Global EXTERNAL_MANAGED load balancer schemes.
+ "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on
+ # the client's Accept-Encoding header.
+ },
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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
diff --git a/docs/dyn/compute_alpha.urlMaps.html b/docs/dyn/compute_alpha.urlMaps.html
index ec00570998..b57ae70c2c 100644
--- a/docs/dyn/compute_alpha.urlMaps.html
+++ b/docs/dyn/compute_alpha.urlMaps.html
@@ -631,6 +631,11 @@ Method Details
# seconds. This field translates to the Access-Control-Max-Age
# header.
},
+ "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for
+ # Global EXTERNAL_MANAGED load balancer schemes.
+ "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on
+ # the client's Accept-Encoding header.
+ },
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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
@@ -1516,6 +1521,11 @@ Method Details
# seconds. This field translates to the Access-Control-Max-Age
# header.
},
+ "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for
+ # Global EXTERNAL_MANAGED load balancer schemes.
+ "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on
+ # the client's Accept-Encoding header.
+ },
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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
@@ -2382,6 +2392,11 @@ Method Details
# seconds. This field translates to the Access-Control-Max-Age
# header.
},
+ "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for
+ # Global EXTERNAL_MANAGED load balancer schemes.
+ "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on
+ # the client's Accept-Encoding header.
+ },
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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
@@ -3510,6 +3525,11 @@ Method Details
# seconds. This field translates to the Access-Control-Max-Age
# header.
},
+ "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for
+ # Global EXTERNAL_MANAGED load balancer schemes.
+ "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on
+ # the client's Accept-Encoding header.
+ },
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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
@@ -4799,6 +4819,11 @@ Method Details
# seconds. This field translates to the Access-Control-Max-Age
# header.
},
+ "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for
+ # Global EXTERNAL_MANAGED load balancer schemes.
+ "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on
+ # the client's Accept-Encoding header.
+ },
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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
@@ -5684,6 +5709,11 @@ Method Details
# seconds. This field translates to the Access-Control-Max-Age
# header.
},
+ "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for
+ # Global EXTERNAL_MANAGED load balancer schemes.
+ "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on
+ # the client's Accept-Encoding header.
+ },
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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
@@ -6550,6 +6580,11 @@ Method Details
# seconds. This field translates to the Access-Control-Max-Age
# header.
},
+ "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for
+ # Global EXTERNAL_MANAGED load balancer schemes.
+ "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on
+ # the client's Accept-Encoding header.
+ },
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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
@@ -7678,6 +7713,11 @@ Method Details
# seconds. This field translates to the Access-Control-Max-Age
# header.
},
+ "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for
+ # Global EXTERNAL_MANAGED load balancer schemes.
+ "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on
+ # the client's Accept-Encoding header.
+ },
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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
@@ -8568,6 +8608,11 @@ Method Details
# seconds. This field translates to the Access-Control-Max-Age
# header.
},
+ "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for
+ # Global EXTERNAL_MANAGED load balancer schemes.
+ "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on
+ # the client's Accept-Encoding header.
+ },
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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
@@ -9453,6 +9498,11 @@ Method Details
# seconds. This field translates to the Access-Control-Max-Age
# header.
},
+ "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for
+ # Global EXTERNAL_MANAGED load balancer schemes.
+ "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on
+ # the client's Accept-Encoding header.
+ },
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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
@@ -10319,6 +10369,11 @@ Method Details
# seconds. This field translates to the Access-Control-Max-Age
# header.
},
+ "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for
+ # Global EXTERNAL_MANAGED load balancer schemes.
+ "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on
+ # the client's Accept-Encoding header.
+ },
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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
@@ -11447,6 +11502,11 @@ Method Details
# seconds. This field translates to the Access-Control-Max-Age
# header.
},
+ "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for
+ # Global EXTERNAL_MANAGED load balancer schemes.
+ "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on
+ # the client's Accept-Encoding header.
+ },
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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
@@ -13078,6 +13138,11 @@ Method Details
# seconds. This field translates to the Access-Control-Max-Age
# header.
},
+ "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for
+ # Global EXTERNAL_MANAGED load balancer schemes.
+ "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on
+ # the client's Accept-Encoding header.
+ },
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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
@@ -13963,6 +14028,11 @@ Method Details
# seconds. This field translates to the Access-Control-Max-Age
# header.
},
+ "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for
+ # Global EXTERNAL_MANAGED load balancer schemes.
+ "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on
+ # the client's Accept-Encoding header.
+ },
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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
@@ -14829,6 +14899,11 @@ Method Details
# seconds. This field translates to the Access-Control-Max-Age
# header.
},
+ "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for
+ # Global EXTERNAL_MANAGED load balancer schemes.
+ "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on
+ # the client's Accept-Encoding header.
+ },
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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
@@ -15957,6 +16032,11 @@ Method Details
# seconds. This field translates to the Access-Control-Max-Age
# header.
},
+ "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for
+ # Global EXTERNAL_MANAGED load balancer schemes.
+ "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on
+ # the client's Accept-Encoding header.
+ },
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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
@@ -16898,6 +16978,11 @@ Method Details
# seconds. This field translates to the Access-Control-Max-Age
# header.
},
+ "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for
+ # Global EXTERNAL_MANAGED load balancer schemes.
+ "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on
+ # the client's Accept-Encoding header.
+ },
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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
@@ -17783,6 +17868,11 @@ Method Details
# seconds. This field translates to the Access-Control-Max-Age
# header.
},
+ "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for
+ # Global EXTERNAL_MANAGED load balancer schemes.
+ "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on
+ # the client's Accept-Encoding header.
+ },
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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
@@ -18649,6 +18739,11 @@ Method Details
# seconds. This field translates to the Access-Control-Max-Age
# header.
},
+ "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for
+ # Global EXTERNAL_MANAGED load balancer schemes.
+ "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on
+ # the client's Accept-Encoding header.
+ },
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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
@@ -19777,6 +19872,11 @@ Method Details
# seconds. This field translates to the Access-Control-Max-Age
# header.
},
+ "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for
+ # Global EXTERNAL_MANAGED load balancer schemes.
+ "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on
+ # the client's Accept-Encoding header.
+ },
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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
@@ -21003,6 +21103,11 @@ Method Details
# seconds. This field translates to the Access-Control-Max-Age
# header.
},
+ "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for
+ # Global EXTERNAL_MANAGED load balancer schemes.
+ "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on
+ # the client's Accept-Encoding header.
+ },
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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
@@ -21888,6 +21993,11 @@ Method Details
# seconds. This field translates to the Access-Control-Max-Age
# header.
},
+ "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for
+ # Global EXTERNAL_MANAGED load balancer schemes.
+ "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on
+ # the client's Accept-Encoding header.
+ },
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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
@@ -22754,6 +22864,11 @@ Method Details
# seconds. This field translates to the Access-Control-Max-Age
# header.
},
+ "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for
+ # Global EXTERNAL_MANAGED load balancer schemes.
+ "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on
+ # the client's Accept-Encoding header.
+ },
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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
@@ -23882,6 +23997,11 @@ Method Details
# seconds. This field translates to the Access-Control-Max-Age
# header.
},
+ "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for
+ # Global EXTERNAL_MANAGED load balancer schemes.
+ "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on
+ # the client's Accept-Encoding header.
+ },
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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
@@ -25094,6 +25214,11 @@ Method Details
# seconds. This field translates to the Access-Control-Max-Age
# header.
},
+ "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for
+ # Global EXTERNAL_MANAGED load balancer schemes.
+ "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on
+ # the client's Accept-Encoding header.
+ },
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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
@@ -25979,6 +26104,11 @@ Method Details
# seconds. This field translates to the Access-Control-Max-Age
# header.
},
+ "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for
+ # Global EXTERNAL_MANAGED load balancer schemes.
+ "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on
+ # the client's Accept-Encoding header.
+ },
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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
@@ -26845,6 +26975,11 @@ Method Details
# seconds. This field translates to the Access-Control-Max-Age
# header.
},
+ "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for
+ # Global EXTERNAL_MANAGED load balancer schemes.
+ "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on
+ # the client's Accept-Encoding header.
+ },
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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
@@ -27973,6 +28108,11 @@ Method Details
# seconds. This field translates to the Access-Control-Max-Age
# header.
},
+ "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for
+ # Global EXTERNAL_MANAGED load balancer schemes.
+ "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on
+ # the client's Accept-Encoding header.
+ },
"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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
diff --git a/docs/dyn/compute_beta.advice.html b/docs/dyn/compute_beta.advice.html
index 4d33380873..4f568712b6 100644
--- a/docs/dyn/compute_beta.advice.html
+++ b/docs/dyn/compute_beta.advice.html
@@ -77,6 +77,9 @@ Instance Methods
calendarMode(project, region, body=None, x__xgafv=None)
Advise how, where and when to create the requested amount of instances
+
+ calendarModeExtension(project, region, body=None, x__xgafv=None)
+Advises on whether extending an existing future reservation is possible
capacity(project, region, body=None, x__xgafv=None)
Advice on making real-time decisions (such as choosing zone or
@@ -209,6 +212,57 @@ Method Details
}
calendarModeExtension(project, region, body=None, x__xgafv=None)
+ Advises on whether extending an existing future reservation is possible
+based on the desired extension end time. If capacity isn't available for
+the entire requested duration, the method recommends the longest possible
+extension.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # A request to recommend the maximum duration for extending an existing future
+ # reservation in calendar mode. The recommended duration is shorter than or
+ # equal to the specified extension duration.
+ "endTimeNotLaterThan": "A String", # Required. The desired end time for the extension.
+ "futureReservation": "A String", # Required. Reference to the future reservation, in the format:
+ # projects/{project}/zones/{zone}/futureReservations/{name}
+ # Full URIs that include hostnames (like compute.googleapis.com or
+ # www.googleapis.com) are also supported.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A response that contains the recommended duration for extending
+ # a future reservation in calendar mode based on available capacity
+ # during the extension period.
+ "endTime": "A String", # The recommended end time for the extension, which is either the end time
+ # requested by the caller or the longest alternative with sufficient
+ # capacity. If the extension is not possible, this field is empty, and
+ # notRecommendedReason is populated instead.
+ "notRecommendedReason": { # Information about why no recommendation was provided. # The reason why the future reservation can't be extended. If a
+ # recommendation is provided, whether for the requested end time or an
+ # alternative, this field is empty.
+ "details": "A String", # Human-readable details describing why the recommendation wasn't provided.
+ # For example, if the status is CONDITIONS_NOT_MET, this field explains why
+ # the requested extension duration isn't possible.
+ "status": "A String", # Status of recommendation.
+ },
+ "recommendationId": "A String", # The unique ID of the recommendation, which is a UUID string generated by
+ # the API.
+}
+capacity(project, region, body=None, x__xgafv=None)
Advice on making real-time decisions (such as choosing zone or diff --git a/docs/dyn/compute_beta.backendServices.html b/docs/dyn/compute_beta.backendServices.html index b0a49cc1cf..942b5f7500 100644 --- a/docs/dyn/compute_beta.backendServices.html +++ b/docs/dyn/compute_beta.backendServices.html @@ -1306,7 +1306,8 @@Method Details
# instance must already be attached to the NEG specified in the # haPolicy.leader.backendGroup. # - # The name must be 1-63 characters long, and comply with RFC1035. + # The value must be a valid RFC1035 name (1-63 characters) or a valid + # instance URL. # Authorization requires the following IAM permission on the # specified resource instance: compute.instances.use }, @@ -3403,7 +3404,8 @@Method Details
# instance must already be attached to the NEG specified in the # haPolicy.leader.backendGroup. # - # The name must be 1-63 characters long, and comply with RFC1035. + # The value must be a valid RFC1035 name (1-63 characters) or a valid + # instance URL. # Authorization requires the following IAM permission on the # specified resource instance: compute.instances.use }, @@ -5970,7 +5972,8 @@Method Details
# instance must already be attached to the NEG specified in the # haPolicy.leader.backendGroup. # - # The name must be 1-63 characters long, and comply with RFC1035. + # The value must be a valid RFC1035 name (1-63 characters) or a valid + # instance URL. # Authorization requires the following IAM permission on the # specified resource instance: compute.instances.use }, @@ -7755,7 +7758,8 @@Method Details
# instance must already be attached to the NEG specified in the # haPolicy.leader.backendGroup. # - # The name must be 1-63 characters long, and comply with RFC1035. + # The value must be a valid RFC1035 name (1-63 characters) or a valid + # instance URL. # Authorization requires the following IAM permission on the # specified resource instance: compute.instances.use }, @@ -9281,7 +9285,8 @@Method Details
# instance must already be attached to the NEG specified in the # haPolicy.leader.backendGroup. # - # The name must be 1-63 characters long, and comply with RFC1035. + # The value must be a valid RFC1035 name (1-63 characters) or a valid + # instance URL. # Authorization requires the following IAM permission on the # specified resource instance: compute.instances.use }, @@ -10747,7 +10752,8 @@Method Details
# instance must already be attached to the NEG specified in the # haPolicy.leader.backendGroup. # - # The name must be 1-63 characters long, and comply with RFC1035. + # The value must be a valid RFC1035 name (1-63 characters) or a valid + # instance URL. # Authorization requires the following IAM permission on the # specified resource instance: compute.instances.use }, @@ -13974,7 +13980,8 @@Method Details
# instance must already be attached to the NEG specified in the # haPolicy.leader.backendGroup. # - # The name must be 1-63 characters long, and comply with RFC1035. + # The value must be a valid RFC1035 name (1-63 characters) or a valid + # instance URL. # Authorization requires the following IAM permission on the # specified resource instance: compute.instances.use }, diff --git a/docs/dyn/compute_beta.instanceGroupManagers.html b/docs/dyn/compute_beta.instanceGroupManagers.html index ad9c5f92ac..e83eb5ecea 100644 --- a/docs/dyn/compute_beta.instanceGroupManagers.html +++ b/docs/dyn/compute_beta.instanceGroupManagers.html @@ -644,6 +644,7 @@Method Details
# instances to apply the configuration. To apply the configuration, set the # group's updatePolicy.type field to use proactive updates or # use the applyUpdatesToInstances method. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID. "labels": { # The label key-value pairs that you want to patch onto the instance. "a_key": "A String", }, @@ -4063,6 +4064,7 @@Method Details
# instances to apply the configuration. To apply the configuration, set the # group's updatePolicy.type field to use proactive updates or # use the applyUpdatesToInstances method. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID. "labels": { # The label key-value pairs that you want to patch onto the instance. "a_key": "A String", }, @@ -5533,6 +5535,7 @@Method Details
# instances to apply the configuration. To apply the configuration, set the # group's updatePolicy.type field to use proactive updates or # use the applyUpdatesToInstances method. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID. "labels": { # The label key-value pairs that you want to patch onto the instance. "a_key": "A String", }, @@ -7238,6 +7241,7 @@Method Details
# instances to apply the configuration. To apply the configuration, set the # group's updatePolicy.type field to use proactive updates or # use the applyUpdatesToInstances method. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID. "labels": { # The label key-value pairs that you want to patch onto the instance. "a_key": "A String", }, @@ -9933,6 +9937,7 @@Method Details
# instances to apply the configuration. To apply the configuration, set the # group's updatePolicy.type field to use proactive updates or # use the applyUpdatesToInstances method. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID. "labels": { # The label key-value pairs that you want to patch onto the instance. "a_key": "A String", }, @@ -15298,6 +15303,7 @@Method Details
# instances to apply the configuration. To apply the configuration, set the # group's updatePolicy.type field to use proactive updates or # use the applyUpdatesToInstances method. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID. "labels": { # The label key-value pairs that you want to patch onto the instance. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.instanceTemplates.html b/docs/dyn/compute_beta.instanceTemplates.html index 28ecf63e02..9c6a10a847 100644 --- a/docs/dyn/compute_beta.instanceTemplates.html +++ b/docs/dyn/compute_beta.instanceTemplates.html @@ -927,6 +927,15 @@Method Details
"aliasIpRanges": [ # An array of alias IP ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -938,6 +947,15 @@Method Details
"aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -1124,6 +1142,8 @@Method Details
"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value # must be a number between 1 and the number of availability domains # specified in the spread placement policy attached to the instance. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID in the + # ResourceStatus resource of the VM. "gracefulShutdown": { # The configuration for gracefully shutting down the instance. "enabled": True or False, # Opts-in for graceful shutdown. "maxDuration": { # A Duration represents a fixed-length span of time represented # The time allotted for the instance to gracefully shut down. If the @@ -2435,6 +2455,15 @@Method Details
"aliasIpRanges": [ # An array of alias IP ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -2446,6 +2475,15 @@Method Details
"aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -2632,6 +2670,8 @@Method Details
"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value # must be a number between 1 and the number of availability domains # specified in the spread placement policy attached to the instance. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID in the + # ResourceStatus resource of the VM. "gracefulShutdown": { # The configuration for gracefully shutting down the instance. "enabled": True or False, # Opts-in for graceful shutdown. "maxDuration": { # A Duration represents a fixed-length span of time represented # The time allotted for the instance to gracefully shut down. If the @@ -3918,6 +3958,15 @@Method Details
"aliasIpRanges": [ # An array of alias IP ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -3929,6 +3978,15 @@Method Details
"aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -4115,6 +4173,8 @@Method Details
"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value # must be a number between 1 and the number of availability domains # specified in the spread placement policy attached to the instance. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID in the + # ResourceStatus resource of the VM. "gracefulShutdown": { # The configuration for gracefully shutting down the instance. "enabled": True or False, # Opts-in for graceful shutdown. "maxDuration": { # A Duration represents a fixed-length span of time represented # The time allotted for the instance to gracefully shut down. If the @@ -5421,6 +5481,15 @@Method Details
"aliasIpRanges": [ # An array of alias IP ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -5432,6 +5501,15 @@Method Details
"aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -5618,6 +5696,8 @@Method Details
"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value # must be a number between 1 and the number of availability domains # specified in the spread placement policy attached to the instance. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID in the + # ResourceStatus resource of the VM. "gracefulShutdown": { # The configuration for gracefully shutting down the instance. "enabled": True or False, # Opts-in for graceful shutdown. "maxDuration": { # A Duration represents a fixed-length span of time represented # The time allotted for the instance to gracefully shut down. If the diff --git a/docs/dyn/compute_beta.instances.html b/docs/dyn/compute_beta.instances.html index 8c46c761cf..2c5784d2d4 100644 --- a/docs/dyn/compute_beta.instances.html +++ b/docs/dyn/compute_beta.instances.html @@ -681,6 +681,15 @@Method Details
"aliasIpRanges": [ # An array of alias IP ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -692,6 +701,15 @@Method Details
"aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -2341,6 +2359,15 @@Method Details
"aliasIpRanges": [ # An array of alias IP ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -2352,6 +2379,15 @@Method Details
"aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -2584,6 +2620,8 @@Method Details
"host": "A String", # [Output Only] The ID of the host on which the running instance is located. # Instances on the same host experience the lowest possible network # latency. + "machine": "A String", # Output only. [Output Only] The ID of the machine on which the running instance is + # located. It is only populated for machines which have multiple hosts. "subblock": "A String", # [Output Only] The ID of the sub-block in which the running instance is # located. Instances in the same sub-block experience lower network latency # than instances in the same block. @@ -2652,6 +2690,8 @@Method Details
"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value # must be a number between 1 and the number of availability domains # specified in the spread placement policy attached to the instance. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID in the + # ResourceStatus resource of the VM. "gracefulShutdown": { # The configuration for gracefully shutting down the instance. "enabled": True or False, # Opts-in for graceful shutdown. "maxDuration": { # A Duration represents a fixed-length span of time represented # The time allotted for the instance to gracefully shut down. If the @@ -5029,6 +5069,15 @@Method Details
"aliasIpRanges": [ # An array of alias IP ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -5040,6 +5089,15 @@Method Details
"aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -5226,6 +5284,8 @@Method Details
"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value # must be a number between 1 and the number of availability domains # specified in the spread placement policy attached to the instance. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID in the + # ResourceStatus resource of the VM. "gracefulShutdown": { # The configuration for gracefully shutting down the instance. "enabled": True or False, # Opts-in for graceful shutdown. "maxDuration": { # A Duration represents a fixed-length span of time represented # The time allotted for the instance to gracefully shut down. If the @@ -7796,6 +7856,15 @@Method Details
"aliasIpRanges": [ # An array of alias IP ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -7807,6 +7876,15 @@Method Details
"aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -8039,6 +8117,8 @@Method Details
"host": "A String", # [Output Only] The ID of the host on which the running instance is located. # Instances on the same host experience the lowest possible network # latency. + "machine": "A String", # Output only. [Output Only] The ID of the machine on which the running instance is + # located. It is only populated for machines which have multiple hosts. "subblock": "A String", # [Output Only] The ID of the sub-block in which the running instance is # located. Instances in the same sub-block experience lower network latency # than instances in the same block. @@ -8107,6 +8187,8 @@Method Details
"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value # must be a number between 1 and the number of availability domains # specified in the spread placement policy attached to the instance. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID in the + # ResourceStatus resource of the VM. "gracefulShutdown": { # The configuration for gracefully shutting down the instance. "enabled": True or False, # Opts-in for graceful shutdown. "maxDuration": { # A Duration represents a fixed-length span of time represented # The time allotted for the instance to gracefully shut down. If the @@ -10828,6 +10910,15 @@Method Details
"aliasIpRanges": [ # An array of alias IP ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -10839,6 +10930,15 @@Method Details
"aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -11071,6 +11171,8 @@Method Details
"host": "A String", # [Output Only] The ID of the host on which the running instance is located. # Instances on the same host experience the lowest possible network # latency. + "machine": "A String", # Output only. [Output Only] The ID of the machine on which the running instance is + # located. It is only populated for machines which have multiple hosts. "subblock": "A String", # [Output Only] The ID of the sub-block in which the running instance is # located. Instances in the same sub-block experience lower network latency # than instances in the same block. @@ -11139,6 +11241,8 @@Method Details
"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value # must be a number between 1 and the number of availability domains # specified in the spread placement policy attached to the instance. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID in the + # ResourceStatus resource of the VM. "gracefulShutdown": { # The configuration for gracefully shutting down the instance. "enabled": True or False, # Opts-in for graceful shutdown. "maxDuration": { # A Duration represents a fixed-length span of time represented # The time allotted for the instance to gracefully shut down. If the @@ -12586,6 +12690,15 @@Method Details
"aliasIpRanges": [ # An array of alias IP ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -12597,6 +12710,15 @@Method Details
"aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -12829,6 +12951,8 @@Method Details
"host": "A String", # [Output Only] The ID of the host on which the running instance is located. # Instances on the same host experience the lowest possible network # latency. + "machine": "A String", # Output only. [Output Only] The ID of the machine on which the running instance is + # located. It is only populated for machines which have multiple hosts. "subblock": "A String", # [Output Only] The ID of the sub-block in which the running instance is # located. Instances in the same sub-block experience lower network latency # than instances in the same block. @@ -12897,6 +13021,8 @@Method Details
"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value # must be a number between 1 and the number of availability domains # specified in the spread placement policy attached to the instance. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID in the + # ResourceStatus resource of the VM. "gracefulShutdown": { # The configuration for gracefully shutting down the instance. "enabled": True or False, # Opts-in for graceful shutdown. "maxDuration": { # A Duration represents a fixed-length span of time represented # The time allotted for the instance to gracefully shut down. If the @@ -18979,6 +19105,8 @@Method Details
"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value # must be a number between 1 and the number of availability domains # specified in the spread placement policy attached to the instance. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID in the + # ResourceStatus resource of the VM. "gracefulShutdown": { # The configuration for gracefully shutting down the instance. "enabled": True or False, # Opts-in for graceful shutdown. "maxDuration": { # A Duration represents a fixed-length span of time represented # The time allotted for the instance to gracefully shut down. If the @@ -23438,6 +23566,15 @@Method Details
"aliasIpRanges": [ # An array of alias IP ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -23449,6 +23586,15 @@Method Details
"aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -23681,6 +23827,8 @@Method Details
"host": "A String", # [Output Only] The ID of the host on which the running instance is located. # Instances on the same host experience the lowest possible network # latency. + "machine": "A String", # Output only. [Output Only] The ID of the machine on which the running instance is + # located. It is only populated for machines which have multiple hosts. "subblock": "A String", # [Output Only] The ID of the sub-block in which the running instance is # located. Instances in the same sub-block experience lower network latency # than instances in the same block. @@ -23749,6 +23897,8 @@Method Details
"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value # must be a number between 1 and the number of availability domains # specified in the spread placement policy attached to the instance. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID in the + # ResourceStatus resource of the VM. "gracefulShutdown": { # The configuration for gracefully shutting down the instance. "enabled": True or False, # Opts-in for graceful shutdown. "maxDuration": { # A Duration represents a fixed-length span of time represented # The time allotted for the instance to gracefully shut down. If the @@ -25041,6 +25191,15 @@Method Details
"aliasIpRanges": [ # An array of alias IP ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -25052,6 +25211,15 @@Method Details
"aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be diff --git a/docs/dyn/compute_beta.interconnects.html b/docs/dyn/compute_beta.interconnects.html index 70bdfda55d..f88f139daf 100644 --- a/docs/dyn/compute_beta.interconnects.html +++ b/docs/dyn/compute_beta.interconnects.html @@ -606,6 +606,9 @@Method Details
# router to fallback to cleartext traffic if the MKA session cannot be # established. By default, the Interconnect connection is configured with amust-secure security policy that drops all traffic if the # MKA session cannot be established with your router. + "interconnectKeyGroup": "A String", # Optional. URL of the InterconnectKeyGroup resource to use for MACsec, in the + # format: + # projects/{project}/locations/{region}/interconnectKeyGroups/{interconnectKeyGroup}. "preSharedKeys": [ # Required. A keychain placeholder describing a set of named key objects # along with their start times. A MACsec CKN/CAK is generated for each # key in the key chain. Google router automatically picks the key with @@ -1053,6 +1056,9 @@Method Details
# router to fallback to cleartext traffic if the MKA session cannot be # established. By default, the Interconnect connection is configured with amust-secure security policy that drops all traffic if the # MKA session cannot be established with your router. + "interconnectKeyGroup": "A String", # Optional. URL of the InterconnectKeyGroup resource to use for MACsec, in the + # format: + # projects/{project}/locations/{region}/interconnectKeyGroups/{interconnectKeyGroup}. "preSharedKeys": [ # Required. A keychain placeholder describing a set of named key objects # along with their start times. A MACsec CKN/CAK is generated for each # key in the key chain. Google router automatically picks the key with @@ -1732,6 +1738,9 @@Method Details
# router to fallback to cleartext traffic if the MKA session cannot be # established. By default, the Interconnect connection is configured with amust-secure security policy that drops all traffic if the # MKA session cannot be established with your router. + "interconnectKeyGroup": "A String", # Optional. URL of the InterconnectKeyGroup resource to use for MACsec, in the + # format: + # projects/{project}/locations/{region}/interconnectKeyGroups/{interconnectKeyGroup}. "preSharedKeys": [ # Required. A keychain placeholder describing a set of named key objects # along with their start times. A MACsec CKN/CAK is generated for each # key in the key chain. Google router automatically picks the key with @@ -2077,6 +2086,9 @@Method Details
# router to fallback to cleartext traffic if the MKA session cannot be # established. By default, the Interconnect connection is configured with amust-secure security policy that drops all traffic if the # MKA session cannot be established with your router. + "interconnectKeyGroup": "A String", # Optional. URL of the InterconnectKeyGroup resource to use for MACsec, in the + # format: + # projects/{project}/locations/{region}/interconnectKeyGroups/{interconnectKeyGroup}. "preSharedKeys": [ # Required. A keychain placeholder describing a set of named key objects # along with their start times. A MACsec CKN/CAK is generated for each # key in the key chain. Google router automatically picks the key with diff --git a/docs/dyn/compute_beta.machineImages.html b/docs/dyn/compute_beta.machineImages.html index fb9b31812e..d28b3ac58a 100644 --- a/docs/dyn/compute_beta.machineImages.html +++ b/docs/dyn/compute_beta.machineImages.html @@ -1115,6 +1115,15 @@Method Details
"aliasIpRanges": [ # An array of alias IP ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -1126,6 +1135,15 @@Method Details
"aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -1312,6 +1330,8 @@Method Details
"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value # must be a number between 1 and the number of availability domains # specified in the spread placement policy attached to the instance. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID in the + # ResourceStatus resource of the VM. "gracefulShutdown": { # The configuration for gracefully shutting down the instance. "enabled": True or False, # Opts-in for graceful shutdown. "maxDuration": { # A Duration represents a fixed-length span of time represented # The time allotted for the instance to gracefully shut down. If the @@ -1908,6 +1928,15 @@Method Details
"aliasIpRanges": [ # An array of alias IP ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -1919,6 +1948,15 @@Method Details
"aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -2062,6 +2100,8 @@Method Details
"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value # must be a number between 1 and the number of availability domains # specified in the spread placement policy attached to the instance. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID in the + # ResourceStatus resource of the VM. "gracefulShutdown": { # The configuration for gracefully shutting down the instance. "enabled": True or False, # Opts-in for graceful shutdown. "maxDuration": { # A Duration represents a fixed-length span of time represented # The time allotted for the instance to gracefully shut down. If the @@ -3274,6 +3314,15 @@Method Details
"aliasIpRanges": [ # An array of alias IP ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -3285,6 +3334,15 @@Method Details
"aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -3471,6 +3529,8 @@Method Details
"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value # must be a number between 1 and the number of availability domains # specified in the spread placement policy attached to the instance. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID in the + # ResourceStatus resource of the VM. "gracefulShutdown": { # The configuration for gracefully shutting down the instance. "enabled": True or False, # Opts-in for graceful shutdown. "maxDuration": { # A Duration represents a fixed-length span of time represented # The time allotted for the instance to gracefully shut down. If the @@ -4067,6 +4127,15 @@Method Details
"aliasIpRanges": [ # An array of alias IP ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -4078,6 +4147,15 @@Method Details
"aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -4221,6 +4299,8 @@Method Details
"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value # must be a number between 1 and the number of availability domains # specified in the spread placement policy attached to the instance. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID in the + # ResourceStatus resource of the VM. "gracefulShutdown": { # The configuration for gracefully shutting down the instance. "enabled": True or False, # Opts-in for graceful shutdown. "maxDuration": { # A Duration represents a fixed-length span of time represented # The time allotted for the instance to gracefully shut down. If the @@ -5449,6 +5529,15 @@Method Details
"aliasIpRanges": [ # An array of alias IP ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -5460,6 +5549,15 @@Method Details
"aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -5646,6 +5744,8 @@Method Details
"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value # must be a number between 1 and the number of availability domains # specified in the spread placement policy attached to the instance. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID in the + # ResourceStatus resource of the VM. "gracefulShutdown": { # The configuration for gracefully shutting down the instance. "enabled": True or False, # Opts-in for graceful shutdown. "maxDuration": { # A Duration represents a fixed-length span of time represented # The time allotted for the instance to gracefully shut down. If the @@ -6242,6 +6342,15 @@Method Details
"aliasIpRanges": [ # An array of alias IP ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -6253,6 +6362,15 @@Method Details
"aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -6396,6 +6514,8 @@Method Details
"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value # must be a number between 1 and the number of availability domains # specified in the spread placement policy attached to the instance. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID in the + # ResourceStatus resource of the VM. "gracefulShutdown": { # The configuration for gracefully shutting down the instance. "enabled": True or False, # Opts-in for graceful shutdown. "maxDuration": { # A Duration represents a fixed-length span of time represented # The time allotted for the instance to gracefully shut down. If the diff --git a/docs/dyn/compute_beta.regionBackendServices.html b/docs/dyn/compute_beta.regionBackendServices.html index e60369b5fe..21e133b046 100644 --- a/docs/dyn/compute_beta.regionBackendServices.html +++ b/docs/dyn/compute_beta.regionBackendServices.html @@ -1179,7 +1179,8 @@Method Details
# instance must already be attached to the NEG specified in the # haPolicy.leader.backendGroup. # - # The name must be 1-63 characters long, and comply with RFC1035. + # The value must be a valid RFC1035 name (1-63 characters) or a valid + # instance URL. # Authorization requires the following IAM permission on the # specified resource instance: compute.instances.use }, @@ -3005,7 +3006,8 @@Method Details
# instance must already be attached to the NEG specified in the # haPolicy.leader.backendGroup. # - # The name must be 1-63 characters long, and comply with RFC1035. + # The value must be a valid RFC1035 name (1-63 characters) or a valid + # instance URL. # Authorization requires the following IAM permission on the # specified resource instance: compute.instances.use }, @@ -4791,7 +4793,8 @@Method Details
# instance must already be attached to the NEG specified in the # haPolicy.leader.backendGroup. # - # The name must be 1-63 characters long, and comply with RFC1035. + # The value must be a valid RFC1035 name (1-63 characters) or a valid + # instance URL. # Authorization requires the following IAM permission on the # specified resource instance: compute.instances.use }, @@ -6319,7 +6322,8 @@Method Details
# instance must already be attached to the NEG specified in the # haPolicy.leader.backendGroup. # - # The name must be 1-63 characters long, and comply with RFC1035. + # The value must be a valid RFC1035 name (1-63 characters) or a valid + # instance URL. # Authorization requires the following IAM permission on the # specified resource instance: compute.instances.use }, @@ -7786,7 +7790,8 @@Method Details
# instance must already be attached to the NEG specified in the # haPolicy.leader.backendGroup. # - # The name must be 1-63 characters long, and comply with RFC1035. + # The value must be a valid RFC1035 name (1-63 characters) or a valid + # instance URL. # Authorization requires the following IAM permission on the # specified resource instance: compute.instances.use }, @@ -10707,7 +10712,8 @@Method Details
# instance must already be attached to the NEG specified in the # haPolicy.leader.backendGroup. # - # The name must be 1-63 characters long, and comply with RFC1035. + # The value must be a valid RFC1035 name (1-63 characters) or a valid + # instance URL. # Authorization requires the following IAM permission on the # specified resource instance: compute.instances.use }, diff --git a/docs/dyn/compute_beta.regionInstanceGroupManagers.html b/docs/dyn/compute_beta.regionInstanceGroupManagers.html index 520b50612e..749ae4dc92 100644 --- a/docs/dyn/compute_beta.regionInstanceGroupManagers.html +++ b/docs/dyn/compute_beta.regionInstanceGroupManagers.html @@ -2596,6 +2596,7 @@Method Details
# instances to apply the configuration. To apply the configuration, set the # group's updatePolicy.type field to use proactive updates or # use the applyUpdatesToInstances method. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID. "labels": { # The label key-value pairs that you want to patch onto the instance. "a_key": "A String", }, @@ -3921,6 +3922,7 @@Method Details
# instances to apply the configuration. To apply the configuration, set the # group's updatePolicy.type field to use proactive updates or # use the applyUpdatesToInstances method. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID. "labels": { # The label key-value pairs that you want to patch onto the instance. "a_key": "A String", }, @@ -5625,6 +5627,7 @@Method Details
# instances to apply the configuration. To apply the configuration, set the # group's updatePolicy.type field to use proactive updates or # use the applyUpdatesToInstances method. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID. "labels": { # The label key-value pairs that you want to patch onto the instance. "a_key": "A String", }, @@ -8310,6 +8313,7 @@Method Details
# instances to apply the configuration. To apply the configuration, set the # group's updatePolicy.type field to use proactive updates or # use the applyUpdatesToInstances method. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID. "labels": { # The label key-value pairs that you want to patch onto the instance. "a_key": "A String", }, @@ -13641,6 +13645,7 @@Method Details
# instances to apply the configuration. To apply the configuration, set the # group's updatePolicy.type field to use proactive updates or # use the applyUpdatesToInstances method. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID. "labels": { # The label key-value pairs that you want to patch onto the instance. "a_key": "A String", }, diff --git a/docs/dyn/compute_beta.regionInstanceTemplates.html b/docs/dyn/compute_beta.regionInstanceTemplates.html index cb8a6a9965..a2528271f6 100644 --- a/docs/dyn/compute_beta.regionInstanceTemplates.html +++ b/docs/dyn/compute_beta.regionInstanceTemplates.html @@ -1127,6 +1127,15 @@Method Details
"aliasIpRanges": [ # An array of alias IP ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -1138,6 +1147,15 @@Method Details
"aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -1324,6 +1342,8 @@Method Details
"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value # must be a number between 1 and the number of availability domains # specified in the spread placement policy attached to the instance. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID in the + # ResourceStatus resource of the VM. "gracefulShutdown": { # The configuration for gracefully shutting down the instance. "enabled": True or False, # Opts-in for graceful shutdown. "maxDuration": { # A Duration represents a fixed-length span of time represented # The time allotted for the instance to gracefully shut down. If the @@ -2240,6 +2260,15 @@Method Details
"aliasIpRanges": [ # An array of alias IP ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -2251,6 +2280,15 @@Method Details
"aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -2437,6 +2475,8 @@Method Details
"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value # must be a number between 1 and the number of availability domains # specified in the spread placement policy attached to the instance. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID in the + # ResourceStatus resource of the VM. "gracefulShutdown": { # The configuration for gracefully shutting down the instance. "enabled": True or False, # Opts-in for graceful shutdown. "maxDuration": { # A Duration represents a fixed-length span of time represented # The time allotted for the instance to gracefully shut down. If the @@ -3744,6 +3784,15 @@Method Details
"aliasIpRanges": [ # An array of alias IP ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -3755,6 +3804,15 @@Method Details
"aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -3941,6 +3999,8 @@Method Details
"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value # must be a number between 1 and the number of availability domains # specified in the spread placement policy attached to the instance. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID in the + # ResourceStatus resource of the VM. "gracefulShutdown": { # The configuration for gracefully shutting down the instance. "enabled": True or False, # Opts-in for graceful shutdown. "maxDuration": { # A Duration represents a fixed-length span of time represented # The time allotted for the instance to gracefully shut down. If the diff --git a/docs/dyn/compute_beta.regionInstances.html b/docs/dyn/compute_beta.regionInstances.html index a3f79b3e5f..82d2b5a72c 100644 --- a/docs/dyn/compute_beta.regionInstances.html +++ b/docs/dyn/compute_beta.regionInstances.html @@ -1315,6 +1315,15 @@Method Details
"aliasIpRanges": [ # An array of alias IP ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -1326,6 +1335,15 @@Method Details
"aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -1512,6 +1530,8 @@Method Details
"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value # must be a number between 1 and the number of availability domains # specified in the spread placement policy attached to the instance. + "exposeHostTopology": True or False, # This optional flag exposes the hashed physical host ID in the + # ResourceStatus resource of the VM. "gracefulShutdown": { # The configuration for gracefully shutting down the instance. "enabled": True or False, # Opts-in for graceful shutdown. "maxDuration": { # A Duration represents a fixed-length span of time represented # The time allotted for the instance to gracefully shut down. If the diff --git a/docs/dyn/compute_beta.regionSslPolicies.html b/docs/dyn/compute_beta.regionSslPolicies.html index 5abc5f5142..77b250edfe 100644 --- a/docs/dyn/compute_beta.regionSslPolicies.html +++ b/docs/dyn/compute_beta.regionSslPolicies.html @@ -83,6 +83,9 @@Instance Methods
get(project, region, sslPolicy, x__xgafv=None)Lists all of the ordered rules present in a single specified policy.
++
+getIamPolicy(project, region, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)Gets the access control policy for a resource. May be empty if no such
insert(project, region, body=None, requestId=None, x__xgafv=None)Creates a new policy in the specified project and region using the data
@@ -98,6 +101,9 @@Instance Methods
patch(project, region, sslPolicy, body=None, requestId=None, x__xgafv=None)Patches the specified SSL policy with the data included in the request.
++
+setIamPolicy(project, region, resource, body=None, x__xgafv=None)Sets the access control policy on the specified resource.
testIamPermissions(project, region, resource, body=None, x__xgafv=None)Returns permissions that a caller has on the specified resource.
@@ -515,6 +521,375 @@Method Details
}
getIamPolicy(project, region, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)
+ Gets the access control policy for a resource. May be empty if no such
+policy or resource exists.
+
+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)
+ optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Identity and Access Management (IAM) policy, which specifies access
+ # controls for Google Cloud resources.
+ #
+ #
+ # A `Policy` is a collection of `bindings`. A `binding` binds one or more
+ # `members`, or principals, to a single `role`. Principals can be user
+ # accounts, service accounts, Google groups, and domains (such as G Suite). A
+ # `role` is a named list of permissions; each `role` can be an IAM predefined
+ # role or a user-created custom role.
+ #
+ # For some types of Google Cloud resources, a `binding` can also specify a
+ # `condition`, which is a logical expression that allows access to a resource
+ # only if the expression evaluates to `true`. A condition can add constraints
+ # based on attributes of the request, the resource, or both. To learn which
+ # resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ #
+ # **JSON example:**
+ #
+ # ```
+ # {
+ # "bindings": [
+ # {
+ # "role": "roles/resourcemanager.organizationAdmin",
+ # "members": [
+ # "user:mike@example.com",
+ # "group:admins@example.com",
+ # "domain:google.com",
+ # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+ # ]
+ # },
+ # {
+ # "role": "roles/resourcemanager.organizationViewer",
+ # "members": [
+ # "user:eve@example.com"
+ # ],
+ # "condition": {
+ # "title": "expirable access",
+ # "description": "Does not grant access after Sep 2020",
+ # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+ # }
+ # }
+ # ],
+ # "etag": "BwWWja0YfJA=",
+ # "version": 3
+ # }
+ # ```
+ #
+ # **YAML example:**
+ #
+ # ```
+ # bindings:
+ # - members:
+ # - user:mike@example.com
+ # - group:admins@example.com
+ # - domain:google.com
+ # - serviceAccount:my-project-id@appspot.gserviceaccount.com
+ # role: roles/resourcemanager.organizationAdmin
+ # - members:
+ # - user:eve@example.com
+ # role: roles/resourcemanager.organizationViewer
+ # condition:
+ # title: expirable access
+ # description: Does not grant access after Sep 2020
+ # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+ # etag: BwWWja0YfJA=
+ # version: 3
+ # ```
+ #
+ # For a description of IAM and its features, see the
+ # [IAM documentation](https://cloud.google.com/iam/docs/).
+ "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+ { # Specifies the audit configuration for a service.
+ # The configuration determines which permission types are logged, and what
+ # identities, if any, are exempted from logging.
+ # An AuditConfig must have one or more AuditLogConfigs.
+ #
+ # If there are AuditConfigs for both `allServices` and a specific service,
+ # the union of the two AuditConfigs is used for that service: the log_types
+ # specified in each AuditConfig are enabled, and the exempted_members in each
+ # AuditLogConfig are exempted.
+ #
+ # Example Policy with multiple AuditConfigs:
+ #
+ # {
+ # "audit_configs": [
+ # {
+ # "service": "allServices",
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # "exempted_members": [
+ # "user:jose@example.com"
+ # ]
+ # },
+ # {
+ # "log_type": "DATA_WRITE"
+ # },
+ # {
+ # "log_type": "ADMIN_READ"
+ # }
+ # ]
+ # },
+ # {
+ # "service": "sampleservice.googleapis.com",
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ"
+ # },
+ # {
+ # "log_type": "DATA_WRITE",
+ # "exempted_members": [
+ # "user:aliya@example.com"
+ # ]
+ # }
+ # ]
+ # }
+ # ]
+ # }
+ #
+ # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
+ # logging. It also exempts `jose@example.com` from DATA_READ logging, and
+ # `aliya@example.com` from DATA_WRITE logging.
+ "auditLogConfigs": [ # The configuration for logging of each type of permission.
+ { # Provides the configuration for logging a type of permissions.
+ # Example:
+ #
+ # {
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # "exempted_members": [
+ # "user:jose@example.com"
+ # ]
+ # },
+ # {
+ # "log_type": "DATA_WRITE"
+ # }
+ # ]
+ # }
+ #
+ # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
+ # jose@example.com from DATA_READ logging.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
+ # permission.
+ # Follows the same format of Binding.members.
+ "A String",
+ ],
+ "logType": "A String", # The log type that this config enables.
+ },
+ ],
+ "service": "A String", # Specifies a service that will be enabled for audit logging.
+ # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
+ # `allServices` is a special value that covers all services.
+ },
+ ],
+ "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally,
+ # may specify a `condition` that determines how and when the `bindings` are
+ # applied. Each of the `bindings` must contain at least one principal.
+ #
+ # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
+ # of these principals can be Google groups. Each occurrence of a principal
+ # counts towards these limits. For example, if the `bindings` grant 50
+ # different roles to `user:alice@example.com`, and not to any other
+ # principal, then you can add another 1,450 principals to the `bindings` in
+ # the `Policy`.
+ { # Associates `members`, or principals, with a `role`.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+ #
+ # If the condition evaluates to `true`, then this binding applies to the
+ # current request.
+ #
+ # If the condition evaluates to `false`, then this binding does not apply to
+ # the current request. However, a different role binding might grant the same
+ # role to one or more of the principals in this binding.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM
+ # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ # 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.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+ # its purpose. This can be used e.g. in UIs which allow to enter the
+ # expression.
+ },
+ "members": [ # Specifies the principals requesting access for a Google Cloud resource.
+ # `members` can have the following values:
+ #
+ # * `allUsers`: A special identifier that represents anyone who is
+ # on the internet; with or without a Google account.
+ #
+ # * `allAuthenticatedUsers`: A special identifier that represents anyone
+ # who is authenticated with a Google account or a service account.
+ # Does not include identities that come from external identity providers
+ # (IdPs) through identity federation.
+ #
+ # * `user:{emailid}`: An email address that represents a specific Google
+ # account. For example, `alice@example.com` .
+ #
+ #
+ # * `serviceAccount:{emailid}`: An email address that represents a Google
+ # service account. For example,
+ # `my-other-app@appspot.gserviceaccount.com`.
+ #
+ # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
+ # identifier for a
+ # [Kubernetes service
+ # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
+ # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
+ #
+ # * `group:{emailid}`: An email address that represents a Google group.
+ # For example, `admins@example.com`.
+ #
+ #
+ # * `domain:{domain}`: The G Suite domain (primary) that represents all the
+ # users of that domain. For example, `google.com` or `example.com`.
+ #
+ #
+ #
+ #
+ # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+ # A single identity in a workforce identity pool.
+ #
+ # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
+ # All workforce identities in a group.
+ #
+ # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+ # All workforce identities with a specific attribute value.
+ #
+ # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
+ # All identities in a workforce identity pool.
+ #
+ # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
+ # A single identity in a workload identity pool.
+ #
+ # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
+ # A workload identity pool group.
+ #
+ # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+ # All identities in a workload identity pool with a certain attribute.
+ #
+ # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
+ # All identities in a workload identity pool.
+ #
+ # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
+ # identifier) representing a user that has been recently deleted. For
+ # example, `alice@example.com?uid=123456789012345678901`. If the user is
+ # recovered, this value reverts to `user:{emailid}` and the recovered user
+ # retains the role in the binding.
+ #
+ # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
+ # unique identifier) representing a service account that has been recently
+ # deleted. For example,
+ # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+ # If the service account is undeleted, this value reverts to
+ # `serviceAccount:{emailid}` and the undeleted service account retains the
+ # role in the binding.
+ #
+ # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
+ # identifier) representing a Google group that has been recently
+ # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
+ # the group is recovered, this value reverts to `group:{emailid}` and the
+ # recovered group retains the role in the binding.
+ #
+ # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+ # Deleted single identity in a workforce identity pool. For example,
+ # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+ "A String",
+ ],
+ "role": "A String", # Role that is assigned to the list of `members`, or principals.
+ # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ #
+ # For an overview of the IAM roles and permissions, see the
+ # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
+ # a list of the available pre-defined roles, see
+ # [here](https://cloud.google.com/iam/docs/understanding-roles).
+ },
+ ],
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+ # prevent simultaneous updates of a policy from overwriting each other.
+ # It is strongly suggested that systems make use of the `etag` in the
+ # read-modify-write cycle to perform policy updates in order to avoid race
+ # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+ # systems are expected to put that etag in the request to `setIamPolicy` to
+ # ensure that their change will be applied to the same version of the policy.
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ "version": 42, # Specifies the format of the policy.
+ #
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+ # are rejected.
+ #
+ # Any operation that affects conditional role bindings must specify version
+ # `3`. This requirement applies to the following operations:
+ #
+ # * Getting a policy that includes a conditional role binding
+ # * Adding a conditional role binding to a policy
+ # * Changing a conditional role binding in a policy
+ # * Removing any role binding, with or without a condition, from a policy
+ # that includes conditions
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ #
+ # If a policy does not include any conditions, operations on that policy may
+ # specify any valid version or leave the field unset.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+insert(project, region, body=None, requestId=None, x__xgafv=None)
Creates a new policy in the specified project and region using the data @@ -1636,6 +2011,881 @@Method Details
}
setIamPolicy(project, region, resource, body=None, x__xgafv=None)
+ Sets the access control policy on the specified resource.
+Replaces any existing policy.
+
+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:
+
+{
+ "bindings": [ # Flatten Policy to create a backwacd compatible wire-format.
+ # Deprecated. Use 'policy' to specify bindings.
+ { # Associates `members`, or principals, with a `role`.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+ #
+ # If the condition evaluates to `true`, then this binding applies to the
+ # current request.
+ #
+ # If the condition evaluates to `false`, then this binding does not apply to
+ # the current request. However, a different role binding might grant the same
+ # role to one or more of the principals in this binding.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM
+ # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ # 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.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+ # its purpose. This can be used e.g. in UIs which allow to enter the
+ # expression.
+ },
+ "members": [ # Specifies the principals requesting access for a Google Cloud resource.
+ # `members` can have the following values:
+ #
+ # * `allUsers`: A special identifier that represents anyone who is
+ # on the internet; with or without a Google account.
+ #
+ # * `allAuthenticatedUsers`: A special identifier that represents anyone
+ # who is authenticated with a Google account or a service account.
+ # Does not include identities that come from external identity providers
+ # (IdPs) through identity federation.
+ #
+ # * `user:{emailid}`: An email address that represents a specific Google
+ # account. For example, `alice@example.com` .
+ #
+ #
+ # * `serviceAccount:{emailid}`: An email address that represents a Google
+ # service account. For example,
+ # `my-other-app@appspot.gserviceaccount.com`.
+ #
+ # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
+ # identifier for a
+ # [Kubernetes service
+ # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
+ # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
+ #
+ # * `group:{emailid}`: An email address that represents a Google group.
+ # For example, `admins@example.com`.
+ #
+ #
+ # * `domain:{domain}`: The G Suite domain (primary) that represents all the
+ # users of that domain. For example, `google.com` or `example.com`.
+ #
+ #
+ #
+ #
+ # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+ # A single identity in a workforce identity pool.
+ #
+ # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
+ # All workforce identities in a group.
+ #
+ # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+ # All workforce identities with a specific attribute value.
+ #
+ # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
+ # All identities in a workforce identity pool.
+ #
+ # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
+ # A single identity in a workload identity pool.
+ #
+ # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
+ # A workload identity pool group.
+ #
+ # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+ # All identities in a workload identity pool with a certain attribute.
+ #
+ # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
+ # All identities in a workload identity pool.
+ #
+ # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
+ # identifier) representing a user that has been recently deleted. For
+ # example, `alice@example.com?uid=123456789012345678901`. If the user is
+ # recovered, this value reverts to `user:{emailid}` and the recovered user
+ # retains the role in the binding.
+ #
+ # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
+ # unique identifier) representing a service account that has been recently
+ # deleted. For example,
+ # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+ # If the service account is undeleted, this value reverts to
+ # `serviceAccount:{emailid}` and the undeleted service account retains the
+ # role in the binding.
+ #
+ # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
+ # identifier) representing a Google group that has been recently
+ # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
+ # the group is recovered, this value reverts to `group:{emailid}` and the
+ # recovered group retains the role in the binding.
+ #
+ # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+ # Deleted single identity in a workforce identity pool. For example,
+ # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+ "A String",
+ ],
+ "role": "A String", # Role that is assigned to the list of `members`, or principals.
+ # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ #
+ # For an overview of the IAM roles and permissions, see the
+ # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
+ # a list of the available pre-defined roles, see
+ # [here](https://cloud.google.com/iam/docs/understanding-roles).
+ },
+ ],
+ "etag": "A String", # Flatten Policy to create a backward compatible wire-format.
+ # Deprecated. Use 'policy' to specify the etag.
+ "policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the 'resource'. The size of
+ # the policy is limited to a few 10s of KB. An empty policy is in general a
+ # valid policy but certain services (like Projects) might reject them.
+ # controls for Google Cloud resources.
+ #
+ #
+ # A `Policy` is a collection of `bindings`. A `binding` binds one or more
+ # `members`, or principals, to a single `role`. Principals can be user
+ # accounts, service accounts, Google groups, and domains (such as G Suite). A
+ # `role` is a named list of permissions; each `role` can be an IAM predefined
+ # role or a user-created custom role.
+ #
+ # For some types of Google Cloud resources, a `binding` can also specify a
+ # `condition`, which is a logical expression that allows access to a resource
+ # only if the expression evaluates to `true`. A condition can add constraints
+ # based on attributes of the request, the resource, or both. To learn which
+ # resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ #
+ # **JSON example:**
+ #
+ # ```
+ # {
+ # "bindings": [
+ # {
+ # "role": "roles/resourcemanager.organizationAdmin",
+ # "members": [
+ # "user:mike@example.com",
+ # "group:admins@example.com",
+ # "domain:google.com",
+ # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+ # ]
+ # },
+ # {
+ # "role": "roles/resourcemanager.organizationViewer",
+ # "members": [
+ # "user:eve@example.com"
+ # ],
+ # "condition": {
+ # "title": "expirable access",
+ # "description": "Does not grant access after Sep 2020",
+ # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+ # }
+ # }
+ # ],
+ # "etag": "BwWWja0YfJA=",
+ # "version": 3
+ # }
+ # ```
+ #
+ # **YAML example:**
+ #
+ # ```
+ # bindings:
+ # - members:
+ # - user:mike@example.com
+ # - group:admins@example.com
+ # - domain:google.com
+ # - serviceAccount:my-project-id@appspot.gserviceaccount.com
+ # role: roles/resourcemanager.organizationAdmin
+ # - members:
+ # - user:eve@example.com
+ # role: roles/resourcemanager.organizationViewer
+ # condition:
+ # title: expirable access
+ # description: Does not grant access after Sep 2020
+ # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+ # etag: BwWWja0YfJA=
+ # version: 3
+ # ```
+ #
+ # For a description of IAM and its features, see the
+ # [IAM documentation](https://cloud.google.com/iam/docs/).
+ "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+ { # Specifies the audit configuration for a service.
+ # The configuration determines which permission types are logged, and what
+ # identities, if any, are exempted from logging.
+ # An AuditConfig must have one or more AuditLogConfigs.
+ #
+ # If there are AuditConfigs for both `allServices` and a specific service,
+ # the union of the two AuditConfigs is used for that service: the log_types
+ # specified in each AuditConfig are enabled, and the exempted_members in each
+ # AuditLogConfig are exempted.
+ #
+ # Example Policy with multiple AuditConfigs:
+ #
+ # {
+ # "audit_configs": [
+ # {
+ # "service": "allServices",
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # "exempted_members": [
+ # "user:jose@example.com"
+ # ]
+ # },
+ # {
+ # "log_type": "DATA_WRITE"
+ # },
+ # {
+ # "log_type": "ADMIN_READ"
+ # }
+ # ]
+ # },
+ # {
+ # "service": "sampleservice.googleapis.com",
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ"
+ # },
+ # {
+ # "log_type": "DATA_WRITE",
+ # "exempted_members": [
+ # "user:aliya@example.com"
+ # ]
+ # }
+ # ]
+ # }
+ # ]
+ # }
+ #
+ # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
+ # logging. It also exempts `jose@example.com` from DATA_READ logging, and
+ # `aliya@example.com` from DATA_WRITE logging.
+ "auditLogConfigs": [ # The configuration for logging of each type of permission.
+ { # Provides the configuration for logging a type of permissions.
+ # Example:
+ #
+ # {
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # "exempted_members": [
+ # "user:jose@example.com"
+ # ]
+ # },
+ # {
+ # "log_type": "DATA_WRITE"
+ # }
+ # ]
+ # }
+ #
+ # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
+ # jose@example.com from DATA_READ logging.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
+ # permission.
+ # Follows the same format of Binding.members.
+ "A String",
+ ],
+ "logType": "A String", # The log type that this config enables.
+ },
+ ],
+ "service": "A String", # Specifies a service that will be enabled for audit logging.
+ # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
+ # `allServices` is a special value that covers all services.
+ },
+ ],
+ "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally,
+ # may specify a `condition` that determines how and when the `bindings` are
+ # applied. Each of the `bindings` must contain at least one principal.
+ #
+ # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
+ # of these principals can be Google groups. Each occurrence of a principal
+ # counts towards these limits. For example, if the `bindings` grant 50
+ # different roles to `user:alice@example.com`, and not to any other
+ # principal, then you can add another 1,450 principals to the `bindings` in
+ # the `Policy`.
+ { # Associates `members`, or principals, with a `role`.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+ #
+ # If the condition evaluates to `true`, then this binding applies to the
+ # current request.
+ #
+ # If the condition evaluates to `false`, then this binding does not apply to
+ # the current request. However, a different role binding might grant the same
+ # role to one or more of the principals in this binding.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM
+ # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ # 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.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+ # its purpose. This can be used e.g. in UIs which allow to enter the
+ # expression.
+ },
+ "members": [ # Specifies the principals requesting access for a Google Cloud resource.
+ # `members` can have the following values:
+ #
+ # * `allUsers`: A special identifier that represents anyone who is
+ # on the internet; with or without a Google account.
+ #
+ # * `allAuthenticatedUsers`: A special identifier that represents anyone
+ # who is authenticated with a Google account or a service account.
+ # Does not include identities that come from external identity providers
+ # (IdPs) through identity federation.
+ #
+ # * `user:{emailid}`: An email address that represents a specific Google
+ # account. For example, `alice@example.com` .
+ #
+ #
+ # * `serviceAccount:{emailid}`: An email address that represents a Google
+ # service account. For example,
+ # `my-other-app@appspot.gserviceaccount.com`.
+ #
+ # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
+ # identifier for a
+ # [Kubernetes service
+ # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
+ # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
+ #
+ # * `group:{emailid}`: An email address that represents a Google group.
+ # For example, `admins@example.com`.
+ #
+ #
+ # * `domain:{domain}`: The G Suite domain (primary) that represents all the
+ # users of that domain. For example, `google.com` or `example.com`.
+ #
+ #
+ #
+ #
+ # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+ # A single identity in a workforce identity pool.
+ #
+ # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
+ # All workforce identities in a group.
+ #
+ # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+ # All workforce identities with a specific attribute value.
+ #
+ # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
+ # All identities in a workforce identity pool.
+ #
+ # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
+ # A single identity in a workload identity pool.
+ #
+ # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
+ # A workload identity pool group.
+ #
+ # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+ # All identities in a workload identity pool with a certain attribute.
+ #
+ # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
+ # All identities in a workload identity pool.
+ #
+ # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
+ # identifier) representing a user that has been recently deleted. For
+ # example, `alice@example.com?uid=123456789012345678901`. If the user is
+ # recovered, this value reverts to `user:{emailid}` and the recovered user
+ # retains the role in the binding.
+ #
+ # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
+ # unique identifier) representing a service account that has been recently
+ # deleted. For example,
+ # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+ # If the service account is undeleted, this value reverts to
+ # `serviceAccount:{emailid}` and the undeleted service account retains the
+ # role in the binding.
+ #
+ # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
+ # identifier) representing a Google group that has been recently
+ # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
+ # the group is recovered, this value reverts to `group:{emailid}` and the
+ # recovered group retains the role in the binding.
+ #
+ # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+ # Deleted single identity in a workforce identity pool. For example,
+ # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+ "A String",
+ ],
+ "role": "A String", # Role that is assigned to the list of `members`, or principals.
+ # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ #
+ # For an overview of the IAM roles and permissions, see the
+ # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
+ # a list of the available pre-defined roles, see
+ # [here](https://cloud.google.com/iam/docs/understanding-roles).
+ },
+ ],
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+ # prevent simultaneous updates of a policy from overwriting each other.
+ # It is strongly suggested that systems make use of the `etag` in the
+ # read-modify-write cycle to perform policy updates in order to avoid race
+ # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+ # systems are expected to put that etag in the request to `setIamPolicy` to
+ # ensure that their change will be applied to the same version of the policy.
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ "version": 42, # Specifies the format of the policy.
+ #
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+ # are rejected.
+ #
+ # Any operation that affects conditional role bindings must specify version
+ # `3`. This requirement applies to the following operations:
+ #
+ # * Getting a policy that includes a conditional role binding
+ # * Adding a conditional role binding to a policy
+ # * Changing a conditional role binding in a policy
+ # * Removing any role binding, with or without a condition, from a policy
+ # that includes conditions
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ #
+ # If a policy does not include any conditions, operations on that policy may
+ # specify any valid version or leave the field unset.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ },
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Identity and Access Management (IAM) policy, which specifies access
+ # controls for Google Cloud resources.
+ #
+ #
+ # A `Policy` is a collection of `bindings`. A `binding` binds one or more
+ # `members`, or principals, to a single `role`. Principals can be user
+ # accounts, service accounts, Google groups, and domains (such as G Suite). A
+ # `role` is a named list of permissions; each `role` can be an IAM predefined
+ # role or a user-created custom role.
+ #
+ # For some types of Google Cloud resources, a `binding` can also specify a
+ # `condition`, which is a logical expression that allows access to a resource
+ # only if the expression evaluates to `true`. A condition can add constraints
+ # based on attributes of the request, the resource, or both. To learn which
+ # resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ #
+ # **JSON example:**
+ #
+ # ```
+ # {
+ # "bindings": [
+ # {
+ # "role": "roles/resourcemanager.organizationAdmin",
+ # "members": [
+ # "user:mike@example.com",
+ # "group:admins@example.com",
+ # "domain:google.com",
+ # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+ # ]
+ # },
+ # {
+ # "role": "roles/resourcemanager.organizationViewer",
+ # "members": [
+ # "user:eve@example.com"
+ # ],
+ # "condition": {
+ # "title": "expirable access",
+ # "description": "Does not grant access after Sep 2020",
+ # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+ # }
+ # }
+ # ],
+ # "etag": "BwWWja0YfJA=",
+ # "version": 3
+ # }
+ # ```
+ #
+ # **YAML example:**
+ #
+ # ```
+ # bindings:
+ # - members:
+ # - user:mike@example.com
+ # - group:admins@example.com
+ # - domain:google.com
+ # - serviceAccount:my-project-id@appspot.gserviceaccount.com
+ # role: roles/resourcemanager.organizationAdmin
+ # - members:
+ # - user:eve@example.com
+ # role: roles/resourcemanager.organizationViewer
+ # condition:
+ # title: expirable access
+ # description: Does not grant access after Sep 2020
+ # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+ # etag: BwWWja0YfJA=
+ # version: 3
+ # ```
+ #
+ # For a description of IAM and its features, see the
+ # [IAM documentation](https://cloud.google.com/iam/docs/).
+ "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+ { # Specifies the audit configuration for a service.
+ # The configuration determines which permission types are logged, and what
+ # identities, if any, are exempted from logging.
+ # An AuditConfig must have one or more AuditLogConfigs.
+ #
+ # If there are AuditConfigs for both `allServices` and a specific service,
+ # the union of the two AuditConfigs is used for that service: the log_types
+ # specified in each AuditConfig are enabled, and the exempted_members in each
+ # AuditLogConfig are exempted.
+ #
+ # Example Policy with multiple AuditConfigs:
+ #
+ # {
+ # "audit_configs": [
+ # {
+ # "service": "allServices",
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # "exempted_members": [
+ # "user:jose@example.com"
+ # ]
+ # },
+ # {
+ # "log_type": "DATA_WRITE"
+ # },
+ # {
+ # "log_type": "ADMIN_READ"
+ # }
+ # ]
+ # },
+ # {
+ # "service": "sampleservice.googleapis.com",
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ"
+ # },
+ # {
+ # "log_type": "DATA_WRITE",
+ # "exempted_members": [
+ # "user:aliya@example.com"
+ # ]
+ # }
+ # ]
+ # }
+ # ]
+ # }
+ #
+ # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
+ # logging. It also exempts `jose@example.com` from DATA_READ logging, and
+ # `aliya@example.com` from DATA_WRITE logging.
+ "auditLogConfigs": [ # The configuration for logging of each type of permission.
+ { # Provides the configuration for logging a type of permissions.
+ # Example:
+ #
+ # {
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # "exempted_members": [
+ # "user:jose@example.com"
+ # ]
+ # },
+ # {
+ # "log_type": "DATA_WRITE"
+ # }
+ # ]
+ # }
+ #
+ # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
+ # jose@example.com from DATA_READ logging.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
+ # permission.
+ # Follows the same format of Binding.members.
+ "A String",
+ ],
+ "logType": "A String", # The log type that this config enables.
+ },
+ ],
+ "service": "A String", # Specifies a service that will be enabled for audit logging.
+ # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
+ # `allServices` is a special value that covers all services.
+ },
+ ],
+ "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally,
+ # may specify a `condition` that determines how and when the `bindings` are
+ # applied. Each of the `bindings` must contain at least one principal.
+ #
+ # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
+ # of these principals can be Google groups. Each occurrence of a principal
+ # counts towards these limits. For example, if the `bindings` grant 50
+ # different roles to `user:alice@example.com`, and not to any other
+ # principal, then you can add another 1,450 principals to the `bindings` in
+ # the `Policy`.
+ { # Associates `members`, or principals, with a `role`.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+ #
+ # If the condition evaluates to `true`, then this binding applies to the
+ # current request.
+ #
+ # If the condition evaluates to `false`, then this binding does not apply to
+ # the current request. However, a different role binding might grant the same
+ # role to one or more of the principals in this binding.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM
+ # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ # 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.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+ # its purpose. This can be used e.g. in UIs which allow to enter the
+ # expression.
+ },
+ "members": [ # Specifies the principals requesting access for a Google Cloud resource.
+ # `members` can have the following values:
+ #
+ # * `allUsers`: A special identifier that represents anyone who is
+ # on the internet; with or without a Google account.
+ #
+ # * `allAuthenticatedUsers`: A special identifier that represents anyone
+ # who is authenticated with a Google account or a service account.
+ # Does not include identities that come from external identity providers
+ # (IdPs) through identity federation.
+ #
+ # * `user:{emailid}`: An email address that represents a specific Google
+ # account. For example, `alice@example.com` .
+ #
+ #
+ # * `serviceAccount:{emailid}`: An email address that represents a Google
+ # service account. For example,
+ # `my-other-app@appspot.gserviceaccount.com`.
+ #
+ # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
+ # identifier for a
+ # [Kubernetes service
+ # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
+ # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
+ #
+ # * `group:{emailid}`: An email address that represents a Google group.
+ # For example, `admins@example.com`.
+ #
+ #
+ # * `domain:{domain}`: The G Suite domain (primary) that represents all the
+ # users of that domain. For example, `google.com` or `example.com`.
+ #
+ #
+ #
+ #
+ # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+ # A single identity in a workforce identity pool.
+ #
+ # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
+ # All workforce identities in a group.
+ #
+ # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+ # All workforce identities with a specific attribute value.
+ #
+ # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
+ # All identities in a workforce identity pool.
+ #
+ # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
+ # A single identity in a workload identity pool.
+ #
+ # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
+ # A workload identity pool group.
+ #
+ # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+ # All identities in a workload identity pool with a certain attribute.
+ #
+ # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
+ # All identities in a workload identity pool.
+ #
+ # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
+ # identifier) representing a user that has been recently deleted. For
+ # example, `alice@example.com?uid=123456789012345678901`. If the user is
+ # recovered, this value reverts to `user:{emailid}` and the recovered user
+ # retains the role in the binding.
+ #
+ # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
+ # unique identifier) representing a service account that has been recently
+ # deleted. For example,
+ # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+ # If the service account is undeleted, this value reverts to
+ # `serviceAccount:{emailid}` and the undeleted service account retains the
+ # role in the binding.
+ #
+ # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
+ # identifier) representing a Google group that has been recently
+ # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
+ # the group is recovered, this value reverts to `group:{emailid}` and the
+ # recovered group retains the role in the binding.
+ #
+ # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+ # Deleted single identity in a workforce identity pool. For example,
+ # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+ "A String",
+ ],
+ "role": "A String", # Role that is assigned to the list of `members`, or principals.
+ # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ #
+ # For an overview of the IAM roles and permissions, see the
+ # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
+ # a list of the available pre-defined roles, see
+ # [here](https://cloud.google.com/iam/docs/understanding-roles).
+ },
+ ],
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+ # prevent simultaneous updates of a policy from overwriting each other.
+ # It is strongly suggested that systems make use of the `etag` in the
+ # read-modify-write cycle to perform policy updates in order to avoid race
+ # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+ # systems are expected to put that etag in the request to `setIamPolicy` to
+ # ensure that their change will be applied to the same version of the policy.
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ "version": 42, # Specifies the format of the policy.
+ #
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+ # are rejected.
+ #
+ # Any operation that affects conditional role bindings must specify version
+ # `3`. This requirement applies to the following operations:
+ #
+ # * Getting a policy that includes a conditional role binding
+ # * Adding a conditional role binding to a policy
+ # * Changing a conditional role binding in a policy
+ # * Removing any role binding, with or without a condition, from a policy
+ # that includes conditions
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ #
+ # If a policy does not include any conditions, operations on that policy may
+ # specify any valid version or leave the field unset.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+testIamPermissions(project, region, resource, body=None, x__xgafv=None)
Returns permissions that a caller has on the specified resource. diff --git a/docs/dyn/compute_beta.regionUrlMaps.html b/docs/dyn/compute_beta.regionUrlMaps.html index 8925182342..85d6f8bcc2 100644 --- a/docs/dyn/compute_beta.regionUrlMaps.html +++ b/docs/dyn/compute_beta.regionUrlMaps.html @@ -824,6 +824,11 @@Method Details
# seconds. This field translates to the Access-Control-Max-Age # header. }, + "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on + # the client's Accept-Encoding header. + }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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 @@ -1709,6 +1714,11 @@Method Details
# seconds. This field translates to the Access-Control-Max-Age # header. }, + "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on + # the client's Accept-Encoding header. + }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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 @@ -2575,6 +2585,11 @@Method Details
# seconds. This field translates to the Access-Control-Max-Age # header. }, + "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on + # the client's Accept-Encoding header. + }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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 @@ -3703,6 +3718,11 @@Method Details
# seconds. This field translates to the Access-Control-Max-Age # header. }, + "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on + # the client's Accept-Encoding header. + }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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 @@ -4588,6 +4608,11 @@Method Details
# seconds. This field translates to the Access-Control-Max-Age # header. }, + "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on + # the client's Accept-Encoding header. + }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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 @@ -5473,6 +5498,11 @@Method Details
# seconds. This field translates to the Access-Control-Max-Age # header. }, + "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on + # the client's Accept-Encoding header. + }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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 @@ -6339,6 +6369,11 @@Method Details
# seconds. This field translates to the Access-Control-Max-Age # header. }, + "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on + # the client's Accept-Encoding header. + }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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 @@ -7467,6 +7502,11 @@Method Details
# seconds. This field translates to the Access-Control-Max-Age # header. }, + "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on + # the client's Accept-Encoding header. + }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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 @@ -9047,6 +9087,11 @@Method Details
# seconds. This field translates to the Access-Control-Max-Age # header. }, + "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on + # the client's Accept-Encoding header. + }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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 @@ -9932,6 +9977,11 @@Method Details
# seconds. This field translates to the Access-Control-Max-Age # header. }, + "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on + # the client's Accept-Encoding header. + }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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 @@ -10798,6 +10848,11 @@Method Details
# seconds. This field translates to the Access-Control-Max-Age # header. }, + "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on + # the client's Accept-Encoding header. + }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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 @@ -11926,6 +11981,11 @@Method Details
# seconds. This field translates to the Access-Control-Max-Age # header. }, + "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on + # the client's Accept-Encoding header. + }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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 @@ -12862,6 +12922,11 @@Method Details
# seconds. This field translates to the Access-Control-Max-Age # header. }, + "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on + # the client's Accept-Encoding header. + }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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 @@ -13747,6 +13812,11 @@Method Details
# seconds. This field translates to the Access-Control-Max-Age # header. }, + "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on + # the client's Accept-Encoding header. + }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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 @@ -14613,6 +14683,11 @@Method Details
# seconds. This field translates to the Access-Control-Max-Age # header. }, + "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on + # the client's Accept-Encoding header. + }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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 @@ -15741,6 +15816,11 @@Method Details
# seconds. This field translates to the Access-Control-Max-Age # header. }, + "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on + # the client's Accept-Encoding header. + }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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 @@ -16945,6 +17025,11 @@Method Details
# seconds. This field translates to the Access-Control-Max-Age # header. }, + "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on + # the client's Accept-Encoding header. + }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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 @@ -17830,6 +17915,11 @@Method Details
# seconds. This field translates to the Access-Control-Max-Age # header. }, + "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on + # the client's Accept-Encoding header. + }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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 @@ -18696,6 +18786,11 @@Method Details
# seconds. This field translates to the Access-Control-Max-Age # header. }, + "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on + # the client's Accept-Encoding header. + }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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 @@ -19824,6 +19919,11 @@Method Details
# seconds. This field translates to the Access-Control-Max-Age # header. }, + "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on + # the client's Accept-Encoding header. + }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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 @@ -20996,6 +21096,11 @@Method Details
# seconds. This field translates to the Access-Control-Max-Age # header. }, + "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on + # the client's Accept-Encoding header. + }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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 @@ -21881,6 +21986,11 @@Method Details
# seconds. This field translates to the Access-Control-Max-Age # header. }, + "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on + # the client's Accept-Encoding header. + }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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 @@ -22747,6 +22857,11 @@Method Details
# seconds. This field translates to the Access-Control-Max-Age # header. }, + "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on + # the client's Accept-Encoding header. + }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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 @@ -23875,6 +23990,11 @@Method Details
# seconds. This field translates to the Access-Control-Max-Age # header. }, + "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on + # the client's Accept-Encoding header. + }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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 diff --git a/docs/dyn/compute_beta.sslPolicies.html b/docs/dyn/compute_beta.sslPolicies.html index 4d527e20f4..9fcf51e9d8 100644 --- a/docs/dyn/compute_beta.sslPolicies.html +++ b/docs/dyn/compute_beta.sslPolicies.html @@ -89,6 +89,9 @@Instance Methods
get(project, sslPolicy, x__xgafv=None)Lists all of the ordered rules present in a single specified policy.
++
+getIamPolicy(project, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)Gets the access control policy for a resource. May be empty if no such
insert(project, body=None, requestId=None, x__xgafv=None)Returns the specified SSL policy resource.
@@ -104,6 +107,9 @@Instance Methods
patch(project, sslPolicy, body=None, requestId=None, x__xgafv=None)Patches the specified SSL policy with the data included in the request.
++
+setIamPolicy(project, resource, body=None, x__xgafv=None)Sets the access control policy on the specified resource.
testIamPermissions(project, resource, body=None, x__xgafv=None)Returns permissions that a caller has on the specified resource.
@@ -798,6 +804,374 @@Method Details
}
getIamPolicy(project, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)
+ Gets the access control policy for a resource. May be empty if no such
+policy or resource exists.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name or id of the resource for this request. (required)
+ optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Identity and Access Management (IAM) policy, which specifies access
+ # controls for Google Cloud resources.
+ #
+ #
+ # A `Policy` is a collection of `bindings`. A `binding` binds one or more
+ # `members`, or principals, to a single `role`. Principals can be user
+ # accounts, service accounts, Google groups, and domains (such as G Suite). A
+ # `role` is a named list of permissions; each `role` can be an IAM predefined
+ # role or a user-created custom role.
+ #
+ # For some types of Google Cloud resources, a `binding` can also specify a
+ # `condition`, which is a logical expression that allows access to a resource
+ # only if the expression evaluates to `true`. A condition can add constraints
+ # based on attributes of the request, the resource, or both. To learn which
+ # resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ #
+ # **JSON example:**
+ #
+ # ```
+ # {
+ # "bindings": [
+ # {
+ # "role": "roles/resourcemanager.organizationAdmin",
+ # "members": [
+ # "user:mike@example.com",
+ # "group:admins@example.com",
+ # "domain:google.com",
+ # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+ # ]
+ # },
+ # {
+ # "role": "roles/resourcemanager.organizationViewer",
+ # "members": [
+ # "user:eve@example.com"
+ # ],
+ # "condition": {
+ # "title": "expirable access",
+ # "description": "Does not grant access after Sep 2020",
+ # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+ # }
+ # }
+ # ],
+ # "etag": "BwWWja0YfJA=",
+ # "version": 3
+ # }
+ # ```
+ #
+ # **YAML example:**
+ #
+ # ```
+ # bindings:
+ # - members:
+ # - user:mike@example.com
+ # - group:admins@example.com
+ # - domain:google.com
+ # - serviceAccount:my-project-id@appspot.gserviceaccount.com
+ # role: roles/resourcemanager.organizationAdmin
+ # - members:
+ # - user:eve@example.com
+ # role: roles/resourcemanager.organizationViewer
+ # condition:
+ # title: expirable access
+ # description: Does not grant access after Sep 2020
+ # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+ # etag: BwWWja0YfJA=
+ # version: 3
+ # ```
+ #
+ # For a description of IAM and its features, see the
+ # [IAM documentation](https://cloud.google.com/iam/docs/).
+ "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+ { # Specifies the audit configuration for a service.
+ # The configuration determines which permission types are logged, and what
+ # identities, if any, are exempted from logging.
+ # An AuditConfig must have one or more AuditLogConfigs.
+ #
+ # If there are AuditConfigs for both `allServices` and a specific service,
+ # the union of the two AuditConfigs is used for that service: the log_types
+ # specified in each AuditConfig are enabled, and the exempted_members in each
+ # AuditLogConfig are exempted.
+ #
+ # Example Policy with multiple AuditConfigs:
+ #
+ # {
+ # "audit_configs": [
+ # {
+ # "service": "allServices",
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # "exempted_members": [
+ # "user:jose@example.com"
+ # ]
+ # },
+ # {
+ # "log_type": "DATA_WRITE"
+ # },
+ # {
+ # "log_type": "ADMIN_READ"
+ # }
+ # ]
+ # },
+ # {
+ # "service": "sampleservice.googleapis.com",
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ"
+ # },
+ # {
+ # "log_type": "DATA_WRITE",
+ # "exempted_members": [
+ # "user:aliya@example.com"
+ # ]
+ # }
+ # ]
+ # }
+ # ]
+ # }
+ #
+ # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
+ # logging. It also exempts `jose@example.com` from DATA_READ logging, and
+ # `aliya@example.com` from DATA_WRITE logging.
+ "auditLogConfigs": [ # The configuration for logging of each type of permission.
+ { # Provides the configuration for logging a type of permissions.
+ # Example:
+ #
+ # {
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # "exempted_members": [
+ # "user:jose@example.com"
+ # ]
+ # },
+ # {
+ # "log_type": "DATA_WRITE"
+ # }
+ # ]
+ # }
+ #
+ # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
+ # jose@example.com from DATA_READ logging.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
+ # permission.
+ # Follows the same format of Binding.members.
+ "A String",
+ ],
+ "logType": "A String", # The log type that this config enables.
+ },
+ ],
+ "service": "A String", # Specifies a service that will be enabled for audit logging.
+ # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
+ # `allServices` is a special value that covers all services.
+ },
+ ],
+ "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally,
+ # may specify a `condition` that determines how and when the `bindings` are
+ # applied. Each of the `bindings` must contain at least one principal.
+ #
+ # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
+ # of these principals can be Google groups. Each occurrence of a principal
+ # counts towards these limits. For example, if the `bindings` grant 50
+ # different roles to `user:alice@example.com`, and not to any other
+ # principal, then you can add another 1,450 principals to the `bindings` in
+ # the `Policy`.
+ { # Associates `members`, or principals, with a `role`.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+ #
+ # If the condition evaluates to `true`, then this binding applies to the
+ # current request.
+ #
+ # If the condition evaluates to `false`, then this binding does not apply to
+ # the current request. However, a different role binding might grant the same
+ # role to one or more of the principals in this binding.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM
+ # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ # 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.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+ # its purpose. This can be used e.g. in UIs which allow to enter the
+ # expression.
+ },
+ "members": [ # Specifies the principals requesting access for a Google Cloud resource.
+ # `members` can have the following values:
+ #
+ # * `allUsers`: A special identifier that represents anyone who is
+ # on the internet; with or without a Google account.
+ #
+ # * `allAuthenticatedUsers`: A special identifier that represents anyone
+ # who is authenticated with a Google account or a service account.
+ # Does not include identities that come from external identity providers
+ # (IdPs) through identity federation.
+ #
+ # * `user:{emailid}`: An email address that represents a specific Google
+ # account. For example, `alice@example.com` .
+ #
+ #
+ # * `serviceAccount:{emailid}`: An email address that represents a Google
+ # service account. For example,
+ # `my-other-app@appspot.gserviceaccount.com`.
+ #
+ # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
+ # identifier for a
+ # [Kubernetes service
+ # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
+ # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
+ #
+ # * `group:{emailid}`: An email address that represents a Google group.
+ # For example, `admins@example.com`.
+ #
+ #
+ # * `domain:{domain}`: The G Suite domain (primary) that represents all the
+ # users of that domain. For example, `google.com` or `example.com`.
+ #
+ #
+ #
+ #
+ # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+ # A single identity in a workforce identity pool.
+ #
+ # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
+ # All workforce identities in a group.
+ #
+ # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+ # All workforce identities with a specific attribute value.
+ #
+ # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
+ # All identities in a workforce identity pool.
+ #
+ # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
+ # A single identity in a workload identity pool.
+ #
+ # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
+ # A workload identity pool group.
+ #
+ # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+ # All identities in a workload identity pool with a certain attribute.
+ #
+ # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
+ # All identities in a workload identity pool.
+ #
+ # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
+ # identifier) representing a user that has been recently deleted. For
+ # example, `alice@example.com?uid=123456789012345678901`. If the user is
+ # recovered, this value reverts to `user:{emailid}` and the recovered user
+ # retains the role in the binding.
+ #
+ # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
+ # unique identifier) representing a service account that has been recently
+ # deleted. For example,
+ # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+ # If the service account is undeleted, this value reverts to
+ # `serviceAccount:{emailid}` and the undeleted service account retains the
+ # role in the binding.
+ #
+ # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
+ # identifier) representing a Google group that has been recently
+ # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
+ # the group is recovered, this value reverts to `group:{emailid}` and the
+ # recovered group retains the role in the binding.
+ #
+ # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+ # Deleted single identity in a workforce identity pool. For example,
+ # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+ "A String",
+ ],
+ "role": "A String", # Role that is assigned to the list of `members`, or principals.
+ # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ #
+ # For an overview of the IAM roles and permissions, see the
+ # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
+ # a list of the available pre-defined roles, see
+ # [here](https://cloud.google.com/iam/docs/understanding-roles).
+ },
+ ],
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+ # prevent simultaneous updates of a policy from overwriting each other.
+ # It is strongly suggested that systems make use of the `etag` in the
+ # read-modify-write cycle to perform policy updates in order to avoid race
+ # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+ # systems are expected to put that etag in the request to `setIamPolicy` to
+ # ensure that their change will be applied to the same version of the policy.
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ "version": 42, # Specifies the format of the policy.
+ #
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+ # are rejected.
+ #
+ # Any operation that affects conditional role bindings must specify version
+ # `3`. This requirement applies to the following operations:
+ #
+ # * Getting a policy that includes a conditional role binding
+ # * Adding a conditional role binding to a policy
+ # * Changing a conditional role binding in a policy
+ # * Removing any role binding, with or without a condition, from a policy
+ # that includes conditions
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ #
+ # If a policy does not include any conditions, operations on that policy may
+ # specify any valid version or leave the field unset.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+insert(project, body=None, requestId=None, x__xgafv=None)
Returns the specified SSL policy resource. @@ -1914,6 +2288,880 @@Method Details
}
setIamPolicy(project, resource, body=None, x__xgafv=None)
+ Sets the access control policy on the specified resource.
+Replaces any existing policy.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name or id of the resource for this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "bindings": [ # Flatten Policy to create a backward compatible wire-format.
+ # Deprecated. Use 'policy' to specify bindings.
+ { # Associates `members`, or principals, with a `role`.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+ #
+ # If the condition evaluates to `true`, then this binding applies to the
+ # current request.
+ #
+ # If the condition evaluates to `false`, then this binding does not apply to
+ # the current request. However, a different role binding might grant the same
+ # role to one or more of the principals in this binding.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM
+ # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ # 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.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+ # its purpose. This can be used e.g. in UIs which allow to enter the
+ # expression.
+ },
+ "members": [ # Specifies the principals requesting access for a Google Cloud resource.
+ # `members` can have the following values:
+ #
+ # * `allUsers`: A special identifier that represents anyone who is
+ # on the internet; with or without a Google account.
+ #
+ # * `allAuthenticatedUsers`: A special identifier that represents anyone
+ # who is authenticated with a Google account or a service account.
+ # Does not include identities that come from external identity providers
+ # (IdPs) through identity federation.
+ #
+ # * `user:{emailid}`: An email address that represents a specific Google
+ # account. For example, `alice@example.com` .
+ #
+ #
+ # * `serviceAccount:{emailid}`: An email address that represents a Google
+ # service account. For example,
+ # `my-other-app@appspot.gserviceaccount.com`.
+ #
+ # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
+ # identifier for a
+ # [Kubernetes service
+ # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
+ # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
+ #
+ # * `group:{emailid}`: An email address that represents a Google group.
+ # For example, `admins@example.com`.
+ #
+ #
+ # * `domain:{domain}`: The G Suite domain (primary) that represents all the
+ # users of that domain. For example, `google.com` or `example.com`.
+ #
+ #
+ #
+ #
+ # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+ # A single identity in a workforce identity pool.
+ #
+ # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
+ # All workforce identities in a group.
+ #
+ # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+ # All workforce identities with a specific attribute value.
+ #
+ # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
+ # All identities in a workforce identity pool.
+ #
+ # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
+ # A single identity in a workload identity pool.
+ #
+ # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
+ # A workload identity pool group.
+ #
+ # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+ # All identities in a workload identity pool with a certain attribute.
+ #
+ # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
+ # All identities in a workload identity pool.
+ #
+ # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
+ # identifier) representing a user that has been recently deleted. For
+ # example, `alice@example.com?uid=123456789012345678901`. If the user is
+ # recovered, this value reverts to `user:{emailid}` and the recovered user
+ # retains the role in the binding.
+ #
+ # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
+ # unique identifier) representing a service account that has been recently
+ # deleted. For example,
+ # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+ # If the service account is undeleted, this value reverts to
+ # `serviceAccount:{emailid}` and the undeleted service account retains the
+ # role in the binding.
+ #
+ # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
+ # identifier) representing a Google group that has been recently
+ # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
+ # the group is recovered, this value reverts to `group:{emailid}` and the
+ # recovered group retains the role in the binding.
+ #
+ # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+ # Deleted single identity in a workforce identity pool. For example,
+ # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+ "A String",
+ ],
+ "role": "A String", # Role that is assigned to the list of `members`, or principals.
+ # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ #
+ # For an overview of the IAM roles and permissions, see the
+ # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
+ # a list of the available pre-defined roles, see
+ # [here](https://cloud.google.com/iam/docs/understanding-roles).
+ },
+ ],
+ "etag": "A String", # Flatten Policy to create a backward compatible wire-format.
+ # Deprecated. Use 'policy' to specify the etag.
+ "policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the 'resource'. The size of
+ # the policy is limited to a few 10s of KB. An empty policy is in general a
+ # valid policy but certain services (like Projects) might reject them.
+ # controls for Google Cloud resources.
+ #
+ #
+ # A `Policy` is a collection of `bindings`. A `binding` binds one or more
+ # `members`, or principals, to a single `role`. Principals can be user
+ # accounts, service accounts, Google groups, and domains (such as G Suite). A
+ # `role` is a named list of permissions; each `role` can be an IAM predefined
+ # role or a user-created custom role.
+ #
+ # For some types of Google Cloud resources, a `binding` can also specify a
+ # `condition`, which is a logical expression that allows access to a resource
+ # only if the expression evaluates to `true`. A condition can add constraints
+ # based on attributes of the request, the resource, or both. To learn which
+ # resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ #
+ # **JSON example:**
+ #
+ # ```
+ # {
+ # "bindings": [
+ # {
+ # "role": "roles/resourcemanager.organizationAdmin",
+ # "members": [
+ # "user:mike@example.com",
+ # "group:admins@example.com",
+ # "domain:google.com",
+ # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+ # ]
+ # },
+ # {
+ # "role": "roles/resourcemanager.organizationViewer",
+ # "members": [
+ # "user:eve@example.com"
+ # ],
+ # "condition": {
+ # "title": "expirable access",
+ # "description": "Does not grant access after Sep 2020",
+ # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+ # }
+ # }
+ # ],
+ # "etag": "BwWWja0YfJA=",
+ # "version": 3
+ # }
+ # ```
+ #
+ # **YAML example:**
+ #
+ # ```
+ # bindings:
+ # - members:
+ # - user:mike@example.com
+ # - group:admins@example.com
+ # - domain:google.com
+ # - serviceAccount:my-project-id@appspot.gserviceaccount.com
+ # role: roles/resourcemanager.organizationAdmin
+ # - members:
+ # - user:eve@example.com
+ # role: roles/resourcemanager.organizationViewer
+ # condition:
+ # title: expirable access
+ # description: Does not grant access after Sep 2020
+ # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+ # etag: BwWWja0YfJA=
+ # version: 3
+ # ```
+ #
+ # For a description of IAM and its features, see the
+ # [IAM documentation](https://cloud.google.com/iam/docs/).
+ "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+ { # Specifies the audit configuration for a service.
+ # The configuration determines which permission types are logged, and what
+ # identities, if any, are exempted from logging.
+ # An AuditConfig must have one or more AuditLogConfigs.
+ #
+ # If there are AuditConfigs for both `allServices` and a specific service,
+ # the union of the two AuditConfigs is used for that service: the log_types
+ # specified in each AuditConfig are enabled, and the exempted_members in each
+ # AuditLogConfig are exempted.
+ #
+ # Example Policy with multiple AuditConfigs:
+ #
+ # {
+ # "audit_configs": [
+ # {
+ # "service": "allServices",
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # "exempted_members": [
+ # "user:jose@example.com"
+ # ]
+ # },
+ # {
+ # "log_type": "DATA_WRITE"
+ # },
+ # {
+ # "log_type": "ADMIN_READ"
+ # }
+ # ]
+ # },
+ # {
+ # "service": "sampleservice.googleapis.com",
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ"
+ # },
+ # {
+ # "log_type": "DATA_WRITE",
+ # "exempted_members": [
+ # "user:aliya@example.com"
+ # ]
+ # }
+ # ]
+ # }
+ # ]
+ # }
+ #
+ # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
+ # logging. It also exempts `jose@example.com` from DATA_READ logging, and
+ # `aliya@example.com` from DATA_WRITE logging.
+ "auditLogConfigs": [ # The configuration for logging of each type of permission.
+ { # Provides the configuration for logging a type of permissions.
+ # Example:
+ #
+ # {
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # "exempted_members": [
+ # "user:jose@example.com"
+ # ]
+ # },
+ # {
+ # "log_type": "DATA_WRITE"
+ # }
+ # ]
+ # }
+ #
+ # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
+ # jose@example.com from DATA_READ logging.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
+ # permission.
+ # Follows the same format of Binding.members.
+ "A String",
+ ],
+ "logType": "A String", # The log type that this config enables.
+ },
+ ],
+ "service": "A String", # Specifies a service that will be enabled for audit logging.
+ # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
+ # `allServices` is a special value that covers all services.
+ },
+ ],
+ "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally,
+ # may specify a `condition` that determines how and when the `bindings` are
+ # applied. Each of the `bindings` must contain at least one principal.
+ #
+ # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
+ # of these principals can be Google groups. Each occurrence of a principal
+ # counts towards these limits. For example, if the `bindings` grant 50
+ # different roles to `user:alice@example.com`, and not to any other
+ # principal, then you can add another 1,450 principals to the `bindings` in
+ # the `Policy`.
+ { # Associates `members`, or principals, with a `role`.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+ #
+ # If the condition evaluates to `true`, then this binding applies to the
+ # current request.
+ #
+ # If the condition evaluates to `false`, then this binding does not apply to
+ # the current request. However, a different role binding might grant the same
+ # role to one or more of the principals in this binding.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM
+ # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ # 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.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+ # its purpose. This can be used e.g. in UIs which allow to enter the
+ # expression.
+ },
+ "members": [ # Specifies the principals requesting access for a Google Cloud resource.
+ # `members` can have the following values:
+ #
+ # * `allUsers`: A special identifier that represents anyone who is
+ # on the internet; with or without a Google account.
+ #
+ # * `allAuthenticatedUsers`: A special identifier that represents anyone
+ # who is authenticated with a Google account or a service account.
+ # Does not include identities that come from external identity providers
+ # (IdPs) through identity federation.
+ #
+ # * `user:{emailid}`: An email address that represents a specific Google
+ # account. For example, `alice@example.com` .
+ #
+ #
+ # * `serviceAccount:{emailid}`: An email address that represents a Google
+ # service account. For example,
+ # `my-other-app@appspot.gserviceaccount.com`.
+ #
+ # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
+ # identifier for a
+ # [Kubernetes service
+ # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
+ # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
+ #
+ # * `group:{emailid}`: An email address that represents a Google group.
+ # For example, `admins@example.com`.
+ #
+ #
+ # * `domain:{domain}`: The G Suite domain (primary) that represents all the
+ # users of that domain. For example, `google.com` or `example.com`.
+ #
+ #
+ #
+ #
+ # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+ # A single identity in a workforce identity pool.
+ #
+ # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
+ # All workforce identities in a group.
+ #
+ # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+ # All workforce identities with a specific attribute value.
+ #
+ # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
+ # All identities in a workforce identity pool.
+ #
+ # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
+ # A single identity in a workload identity pool.
+ #
+ # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
+ # A workload identity pool group.
+ #
+ # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+ # All identities in a workload identity pool with a certain attribute.
+ #
+ # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
+ # All identities in a workload identity pool.
+ #
+ # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
+ # identifier) representing a user that has been recently deleted. For
+ # example, `alice@example.com?uid=123456789012345678901`. If the user is
+ # recovered, this value reverts to `user:{emailid}` and the recovered user
+ # retains the role in the binding.
+ #
+ # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
+ # unique identifier) representing a service account that has been recently
+ # deleted. For example,
+ # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+ # If the service account is undeleted, this value reverts to
+ # `serviceAccount:{emailid}` and the undeleted service account retains the
+ # role in the binding.
+ #
+ # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
+ # identifier) representing a Google group that has been recently
+ # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
+ # the group is recovered, this value reverts to `group:{emailid}` and the
+ # recovered group retains the role in the binding.
+ #
+ # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+ # Deleted single identity in a workforce identity pool. For example,
+ # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+ "A String",
+ ],
+ "role": "A String", # Role that is assigned to the list of `members`, or principals.
+ # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ #
+ # For an overview of the IAM roles and permissions, see the
+ # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
+ # a list of the available pre-defined roles, see
+ # [here](https://cloud.google.com/iam/docs/understanding-roles).
+ },
+ ],
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+ # prevent simultaneous updates of a policy from overwriting each other.
+ # It is strongly suggested that systems make use of the `etag` in the
+ # read-modify-write cycle to perform policy updates in order to avoid race
+ # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+ # systems are expected to put that etag in the request to `setIamPolicy` to
+ # ensure that their change will be applied to the same version of the policy.
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ "version": 42, # Specifies the format of the policy.
+ #
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+ # are rejected.
+ #
+ # Any operation that affects conditional role bindings must specify version
+ # `3`. This requirement applies to the following operations:
+ #
+ # * Getting a policy that includes a conditional role binding
+ # * Adding a conditional role binding to a policy
+ # * Changing a conditional role binding in a policy
+ # * Removing any role binding, with or without a condition, from a policy
+ # that includes conditions
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ #
+ # If a policy does not include any conditions, operations on that policy may
+ # specify any valid version or leave the field unset.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ },
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Identity and Access Management (IAM) policy, which specifies access
+ # controls for Google Cloud resources.
+ #
+ #
+ # A `Policy` is a collection of `bindings`. A `binding` binds one or more
+ # `members`, or principals, to a single `role`. Principals can be user
+ # accounts, service accounts, Google groups, and domains (such as G Suite). A
+ # `role` is a named list of permissions; each `role` can be an IAM predefined
+ # role or a user-created custom role.
+ #
+ # For some types of Google Cloud resources, a `binding` can also specify a
+ # `condition`, which is a logical expression that allows access to a resource
+ # only if the expression evaluates to `true`. A condition can add constraints
+ # based on attributes of the request, the resource, or both. To learn which
+ # resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ #
+ # **JSON example:**
+ #
+ # ```
+ # {
+ # "bindings": [
+ # {
+ # "role": "roles/resourcemanager.organizationAdmin",
+ # "members": [
+ # "user:mike@example.com",
+ # "group:admins@example.com",
+ # "domain:google.com",
+ # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+ # ]
+ # },
+ # {
+ # "role": "roles/resourcemanager.organizationViewer",
+ # "members": [
+ # "user:eve@example.com"
+ # ],
+ # "condition": {
+ # "title": "expirable access",
+ # "description": "Does not grant access after Sep 2020",
+ # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+ # }
+ # }
+ # ],
+ # "etag": "BwWWja0YfJA=",
+ # "version": 3
+ # }
+ # ```
+ #
+ # **YAML example:**
+ #
+ # ```
+ # bindings:
+ # - members:
+ # - user:mike@example.com
+ # - group:admins@example.com
+ # - domain:google.com
+ # - serviceAccount:my-project-id@appspot.gserviceaccount.com
+ # role: roles/resourcemanager.organizationAdmin
+ # - members:
+ # - user:eve@example.com
+ # role: roles/resourcemanager.organizationViewer
+ # condition:
+ # title: expirable access
+ # description: Does not grant access after Sep 2020
+ # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+ # etag: BwWWja0YfJA=
+ # version: 3
+ # ```
+ #
+ # For a description of IAM and its features, see the
+ # [IAM documentation](https://cloud.google.com/iam/docs/).
+ "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+ { # Specifies the audit configuration for a service.
+ # The configuration determines which permission types are logged, and what
+ # identities, if any, are exempted from logging.
+ # An AuditConfig must have one or more AuditLogConfigs.
+ #
+ # If there are AuditConfigs for both `allServices` and a specific service,
+ # the union of the two AuditConfigs is used for that service: the log_types
+ # specified in each AuditConfig are enabled, and the exempted_members in each
+ # AuditLogConfig are exempted.
+ #
+ # Example Policy with multiple AuditConfigs:
+ #
+ # {
+ # "audit_configs": [
+ # {
+ # "service": "allServices",
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # "exempted_members": [
+ # "user:jose@example.com"
+ # ]
+ # },
+ # {
+ # "log_type": "DATA_WRITE"
+ # },
+ # {
+ # "log_type": "ADMIN_READ"
+ # }
+ # ]
+ # },
+ # {
+ # "service": "sampleservice.googleapis.com",
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ"
+ # },
+ # {
+ # "log_type": "DATA_WRITE",
+ # "exempted_members": [
+ # "user:aliya@example.com"
+ # ]
+ # }
+ # ]
+ # }
+ # ]
+ # }
+ #
+ # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
+ # logging. It also exempts `jose@example.com` from DATA_READ logging, and
+ # `aliya@example.com` from DATA_WRITE logging.
+ "auditLogConfigs": [ # The configuration for logging of each type of permission.
+ { # Provides the configuration for logging a type of permissions.
+ # Example:
+ #
+ # {
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # "exempted_members": [
+ # "user:jose@example.com"
+ # ]
+ # },
+ # {
+ # "log_type": "DATA_WRITE"
+ # }
+ # ]
+ # }
+ #
+ # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
+ # jose@example.com from DATA_READ logging.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
+ # permission.
+ # Follows the same format of Binding.members.
+ "A String",
+ ],
+ "logType": "A String", # The log type that this config enables.
+ },
+ ],
+ "service": "A String", # Specifies a service that will be enabled for audit logging.
+ # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
+ # `allServices` is a special value that covers all services.
+ },
+ ],
+ "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally,
+ # may specify a `condition` that determines how and when the `bindings` are
+ # applied. Each of the `bindings` must contain at least one principal.
+ #
+ # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
+ # of these principals can be Google groups. Each occurrence of a principal
+ # counts towards these limits. For example, if the `bindings` grant 50
+ # different roles to `user:alice@example.com`, and not to any other
+ # principal, then you can add another 1,450 principals to the `bindings` in
+ # the `Policy`.
+ { # Associates `members`, or principals, with a `role`.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+ #
+ # If the condition evaluates to `true`, then this binding applies to the
+ # current request.
+ #
+ # If the condition evaluates to `false`, then this binding does not apply to
+ # the current request. However, a different role binding might grant the same
+ # role to one or more of the principals in this binding.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM
+ # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ # 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.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+ # its purpose. This can be used e.g. in UIs which allow to enter the
+ # expression.
+ },
+ "members": [ # Specifies the principals requesting access for a Google Cloud resource.
+ # `members` can have the following values:
+ #
+ # * `allUsers`: A special identifier that represents anyone who is
+ # on the internet; with or without a Google account.
+ #
+ # * `allAuthenticatedUsers`: A special identifier that represents anyone
+ # who is authenticated with a Google account or a service account.
+ # Does not include identities that come from external identity providers
+ # (IdPs) through identity federation.
+ #
+ # * `user:{emailid}`: An email address that represents a specific Google
+ # account. For example, `alice@example.com` .
+ #
+ #
+ # * `serviceAccount:{emailid}`: An email address that represents a Google
+ # service account. For example,
+ # `my-other-app@appspot.gserviceaccount.com`.
+ #
+ # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
+ # identifier for a
+ # [Kubernetes service
+ # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
+ # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
+ #
+ # * `group:{emailid}`: An email address that represents a Google group.
+ # For example, `admins@example.com`.
+ #
+ #
+ # * `domain:{domain}`: The G Suite domain (primary) that represents all the
+ # users of that domain. For example, `google.com` or `example.com`.
+ #
+ #
+ #
+ #
+ # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+ # A single identity in a workforce identity pool.
+ #
+ # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
+ # All workforce identities in a group.
+ #
+ # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+ # All workforce identities with a specific attribute value.
+ #
+ # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
+ # All identities in a workforce identity pool.
+ #
+ # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
+ # A single identity in a workload identity pool.
+ #
+ # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
+ # A workload identity pool group.
+ #
+ # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+ # All identities in a workload identity pool with a certain attribute.
+ #
+ # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
+ # All identities in a workload identity pool.
+ #
+ # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
+ # identifier) representing a user that has been recently deleted. For
+ # example, `alice@example.com?uid=123456789012345678901`. If the user is
+ # recovered, this value reverts to `user:{emailid}` and the recovered user
+ # retains the role in the binding.
+ #
+ # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
+ # unique identifier) representing a service account that has been recently
+ # deleted. For example,
+ # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+ # If the service account is undeleted, this value reverts to
+ # `serviceAccount:{emailid}` and the undeleted service account retains the
+ # role in the binding.
+ #
+ # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
+ # identifier) representing a Google group that has been recently
+ # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
+ # the group is recovered, this value reverts to `group:{emailid}` and the
+ # recovered group retains the role in the binding.
+ #
+ # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+ # Deleted single identity in a workforce identity pool. For example,
+ # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+ "A String",
+ ],
+ "role": "A String", # Role that is assigned to the list of `members`, or principals.
+ # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ #
+ # For an overview of the IAM roles and permissions, see the
+ # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
+ # a list of the available pre-defined roles, see
+ # [here](https://cloud.google.com/iam/docs/understanding-roles).
+ },
+ ],
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+ # prevent simultaneous updates of a policy from overwriting each other.
+ # It is strongly suggested that systems make use of the `etag` in the
+ # read-modify-write cycle to perform policy updates in order to avoid race
+ # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+ # systems are expected to put that etag in the request to `setIamPolicy` to
+ # ensure that their change will be applied to the same version of the policy.
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ "version": 42, # Specifies the format of the policy.
+ #
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+ # are rejected.
+ #
+ # Any operation that affects conditional role bindings must specify version
+ # `3`. This requirement applies to the following operations:
+ #
+ # * Getting a policy that includes a conditional role binding
+ # * Adding a conditional role binding to a policy
+ # * Changing a conditional role binding in a policy
+ # * Removing any role binding, with or without a condition, from a policy
+ # that includes conditions
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ #
+ # If a policy does not include any conditions, operations on that policy may
+ # specify any valid version or leave the field unset.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+testIamPermissions(project, resource, body=None, x__xgafv=None)
Returns permissions that a caller has on the specified resource. diff --git a/docs/dyn/compute_beta.urlMaps.html b/docs/dyn/compute_beta.urlMaps.html index 2d9e83c721..ec2346af62 100644 --- a/docs/dyn/compute_beta.urlMaps.html +++ b/docs/dyn/compute_beta.urlMaps.html @@ -631,6 +631,11 @@Method Details
# seconds. This field translates to the Access-Control-Max-Age # header. }, + "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on + # the client's Accept-Encoding header. + }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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 @@ -1516,6 +1521,11 @@Method Details
# seconds. This field translates to the Access-Control-Max-Age # header. }, + "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on + # the client's Accept-Encoding header. + }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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 @@ -2382,6 +2392,11 @@Method Details
# seconds. This field translates to the Access-Control-Max-Age # header. }, + "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on + # the client's Accept-Encoding header. + }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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 @@ -3510,6 +3525,11 @@Method Details
# seconds. This field translates to the Access-Control-Max-Age # header. }, + "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on + # the client's Accept-Encoding header. + }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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 @@ -4786,6 +4806,11 @@Method Details
# seconds. This field translates to the Access-Control-Max-Age # header. }, + "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on + # the client's Accept-Encoding header. + }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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 @@ -5671,6 +5696,11 @@Method Details
# seconds. This field translates to the Access-Control-Max-Age # header. }, + "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on + # the client's Accept-Encoding header. + }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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 @@ -6537,6 +6567,11 @@Method Details
# seconds. This field translates to the Access-Control-Max-Age # header. }, + "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on + # the client's Accept-Encoding header. + }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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 @@ -7665,6 +7700,11 @@Method Details
# seconds. This field translates to the Access-Control-Max-Age # header. }, + "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on + # the client's Accept-Encoding header. + }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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 @@ -8549,6 +8589,11 @@Method Details
# seconds. This field translates to the Access-Control-Max-Age # header. }, + "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on + # the client's Accept-Encoding header. + }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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 @@ -9434,6 +9479,11 @@Method Details
# seconds. This field translates to the Access-Control-Max-Age # header. }, + "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on + # the client's Accept-Encoding header. + }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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 @@ -10300,6 +10350,11 @@Method Details
# seconds. This field translates to the Access-Control-Max-Age # header. }, + "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on + # the client's Accept-Encoding header. + }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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 @@ -11428,6 +11483,11 @@Method Details
# seconds. This field translates to the Access-Control-Max-Age # header. }, + "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on + # the client's Accept-Encoding header. + }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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 @@ -13028,6 +13088,11 @@Method Details
# seconds. This field translates to the Access-Control-Max-Age # header. }, + "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on + # the client's Accept-Encoding header. + }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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 @@ -13913,6 +13978,11 @@Method Details
# seconds. This field translates to the Access-Control-Max-Age # header. }, + "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on + # the client's Accept-Encoding header. + }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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 @@ -14779,6 +14849,11 @@Method Details
# seconds. This field translates to the Access-Control-Max-Age # header. }, + "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on + # the client's Accept-Encoding header. + }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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 @@ -15907,6 +15982,11 @@Method Details
# seconds. This field translates to the Access-Control-Max-Age # header. }, + "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on + # the client's Accept-Encoding header. + }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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 @@ -16842,6 +16922,11 @@Method Details
# seconds. This field translates to the Access-Control-Max-Age # header. }, + "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on + # the client's Accept-Encoding header. + }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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 @@ -17727,6 +17812,11 @@Method Details
# seconds. This field translates to the Access-Control-Max-Age # header. }, + "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on + # the client's Accept-Encoding header. + }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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 @@ -18593,6 +18683,11 @@Method Details
# seconds. This field translates to the Access-Control-Max-Age # header. }, + "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on + # the client's Accept-Encoding header. + }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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 @@ -19721,6 +19816,11 @@Method Details
# seconds. This field translates to the Access-Control-Max-Age # header. }, + "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on + # the client's Accept-Encoding header. + }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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 @@ -20934,6 +21034,11 @@Method Details
# seconds. This field translates to the Access-Control-Max-Age # header. }, + "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on + # the client's Accept-Encoding header. + }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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 @@ -21819,6 +21924,11 @@Method Details
# seconds. This field translates to the Access-Control-Max-Age # header. }, + "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on + # the client's Accept-Encoding header. + }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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 @@ -22685,6 +22795,11 @@Method Details
# seconds. This field translates to the Access-Control-Max-Age # header. }, + "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on + # the client's Accept-Encoding header. + }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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 @@ -23813,6 +23928,11 @@Method Details
# seconds. This field translates to the Access-Control-Max-Age # header. }, + "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on + # the client's Accept-Encoding header. + }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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 @@ -25012,6 +25132,11 @@Method Details
# seconds. This field translates to the Access-Control-Max-Age # header. }, + "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on + # the client's Accept-Encoding header. + }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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 @@ -25897,6 +26022,11 @@Method Details
# seconds. This field translates to the Access-Control-Max-Age # header. }, + "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on + # the client's Accept-Encoding header. + }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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 @@ -26763,6 +26893,11 @@Method Details
# seconds. This field translates to the Access-Control-Max-Age # header. }, + "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on + # the client's Accept-Encoding header. + }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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 @@ -27891,6 +28026,11 @@Method Details
# seconds. This field translates to the Access-Control-Max-Age # header. }, + "dynamicCompressionPolicy": { # Dynamic compression policy for this URL Map's route. # Dynamic compression policy for this URL Map's route. Available only for + # Global EXTERNAL_MANAGED load balancer schemes. + "compressionMode": "A String", # Compress text responses using Brotli or gzip compression, based on + # the client's Accept-Encoding header. + }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # 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 diff --git a/googleapiclient/discovery_cache/documents/compute.alpha.json b/googleapiclient/discovery_cache/documents/compute.alpha.json index fed19edca7..8b8eaf65d8 100644 --- a/googleapiclient/discovery_cache/documents/compute.alpha.json +++ b/googleapiclient/discovery_cache/documents/compute.alpha.json @@ -1245,7 +1245,7 @@ ] }, "calendarModeExtension": { -"description": "Advise on whether extending an existing Future Reservation is possible\nbased on the desired extension end time. If capacity is not available for\nthe entire requested duration, the method will recommend the longest\npossible extension.", +"description": "Advises on whether extending an existing future reservation is possible\nbased on the desired extension end time. If capacity isn't available for\nthe entire requested duration, the method recommends the longest possible\nextension.", "flatPath": "projects/{project}/regions/{region}/advice/calendarModeExtension", "httpMethod": "POST", "id": "compute.advice.calendarModeExtension", @@ -58435,7 +58435,7 @@ } } }, -"revision": "20260821", +"revision": "20260828", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -63042,6 +63042,10 @@ false "description": "The URL of the network to which this backend service belongs.\n\nThis field must be set for Internal Passthrough Network Load Balancers when\nthe haPolicy is enabled, and for External Passthrough Network Load\nBalancers when the haPolicy fastIpMove is enabled.\n\nThis field can only be specified when the load balancing scheme is set toINTERNAL, or when the load balancing scheme is set toEXTERNAL and haPolicy fastIpMove is enabled.", "type": "string" }, +"networkAttachment": { +"description": "Optional. The URL of the network attachment that this resource\nbelongs to.projects/{project}/regions/{region_name}/networkAttachments/{network_attachment_name}.", +"type": "string" +}, "networkPassThroughLbTrafficPolicy": { "$ref": "BackendServiceNetworkPassThroughLbTrafficPolicy", "description": "Configures traffic steering properties of internal passthrough Network\nLoad Balancers.\n\nnetworkPassThroughLbTrafficPolicy cannot be specified with haPolicy." @@ -63125,6 +63129,10 @@ false }, "type": "array" }, +"serviceClassId": { +"description": "Optional. The service class ID associated with this resource.\nProducer Service's Service class ID for the region of this backend\nservice. Can only be used with network_attachment. It is not possible to\nuse on its own; however, network_attachment can be used without\nservice_class_id.", +"type": "string" +}, "serviceLbPolicy": { "description": "URL to networkservices.ServiceLbPolicy resource.\n\nCan only be set if load balancing scheme is EXTERNAL_MANAGED,\nINTERNAL_MANAGED or INTERNAL_SELF_MANAGED for a global backend service, and\nEXTERNAL_MANAGED or INTERNAL_MANAGED for a regional backend service. For a\nglobal backend service, the service lb policy must be global. For a\nregional backend service, the service lb policy must be regional and in the\nsame region.", "type": "string" @@ -63652,7 +63660,7 @@ false "id": "BackendServiceHAPolicyLeaderNetworkEndpoint", "properties": { "instance": { -"description": "The name of the VM instance of the leader network endpoint. The\ninstance must already be attached to the NEG specified in the\nhaPolicy.leader.backendGroup.\n\nThe name must be 1-63 characters long, and comply with RFC1035.\nAuthorization requires the following IAM permission on the\nspecified resource instance: compute.instances.use", +"description": "The name of the VM instance of the leader network endpoint. The\ninstance must already be attached to the NEG specified in the\nhaPolicy.leader.backendGroup.\n\nThe value must be a valid RFC1035 name (1-63 characters) or a valid\ninstance URL.\nAuthorization requires the following IAM permission on the\nspecified resource instance: compute.instances.use", "type": "string" } }, @@ -65238,36 +65246,36 @@ false "type": "object" }, "CalendarModeExtensionAdviceRequest": { -"description": "A request to recommend the best duration for extending an existing\nFuture Reservation in CALENDAR mode, that is equal or less than the specified\nextension duration.", +"description": "A request to recommend the maximum duration for extending an existing future\nreservation in calendar mode. The recommended duration is shorter than or\nequal to the specified extension duration.", "id": "CalendarModeExtensionAdviceRequest", "properties": { "endTimeNotLaterThan": { -"description": "Required. The desired end time after the Future Reservation is extended.", +"description": "Required. The desired end time for the extension.", "format": "google-datetime", "type": "string" }, "futureReservation": { -"description": "Required. Reference to the Future Reservation, in the format:\nprojects/{project}/zones/{zone}/futureReservations/{name}\nFull URIs that include hostnames (like compute.googleapis.com or\nwww.googleapis.com) are also supported.", +"description": "Required. Reference to the future reservation, in the format:\nprojects/{project}/zones/{zone}/futureReservations/{name}\nFull URIs that include hostnames (like compute.googleapis.com or\nwww.googleapis.com) are also supported.", "type": "string" } }, "type": "object" }, "CalendarModeExtensionAdviceResponse": { -"description": "A response containing the recommended duration to extend a\nFuture Reservation in CALENDAR mode based on the available capacity during\nthe extension period.", +"description": "A response that contains the recommended duration for extending\na future reservation in calendar mode based on available capacity\nduring the extension period.", "id": "CalendarModeExtensionAdviceResponse", "properties": { "endTime": { -"description": "The recommended end time for the extension, which will either be\nthe end time requested by the caller or the longest alternative for\nwhich there is sufficient capacity. If extension is not possible, this\nfield will be empty, and not_recommended_reason will be populated instead.", +"description": "The recommended end time for the extension, which is either the end time\nrequested by the caller or the longest alternative with sufficient\ncapacity. If the extension is not possible, this field is empty, and\nnotRecommendedReason is populated instead.", "format": "google-datetime", "type": "string" }, "notRecommendedReason": { "$ref": "CalendarModeExtensionAdviceResponseNotRecommendedReason", -"description": "Information regarding the reason why the Future Reservation\ncannot be extended at all. If a recommendation is provided, whether that is\nthe requested end time or an alternative, this field will be empty." +"description": "The reason why the future reservation can't be extended. If a\nrecommendation is provided, whether for the requested end time or an\nalternative, this field is empty." }, "recommendationId": { -"description": "Unique id of the recommendation, a UUID string generated by the API.", +"description": "The unique ID of the recommendation, which is a UUID string generated by\nthe API.", "type": "string" } }, @@ -65278,7 +65286,7 @@ false "id": "CalendarModeExtensionAdviceResponseNotRecommendedReason", "properties": { "details": { -"description": "Details (human readable) describing why the recommendation\nwas not provided. For example, if the status is CONDITION_NOT_MET,\nthen this field will contain information about why the requested\nextension duration is not eligible.", +"description": "Human-readable details describing why the recommendation wasn't provided.\nFor example, if the status is CONDITIONS_NOT_MET, this field explains why\nthe requested extension duration isn't possible.", "type": "string" }, "status": { @@ -65289,7 +65297,7 @@ false "NO_CAPACITY" ], "enumDescriptions": [ -"The requested extension window does not meet the\nrequired conditions.", +"The requested extension window doesn't meet the\nrequired conditions.", "Default value, unused.", "There is no available capacity for the extension to be provided." ], @@ -65377,7 +65385,7 @@ false "Picks zones for creating VM instances to fulfill the requested number\nof VMs within present resource constraints.", "Creates all VM instances within a single zone. The zone is selected\nbased on the present resource constraints.", "Prioritizes acquisition of resources, scheduling VMs in zones where\nresources are available while distributing VMs as evenly as possible\nacross selected zones to minimize the impact of zonal failure.", -"" +"Default value, unused." ], "type": "string" }, @@ -65624,7 +65632,7 @@ false "PRICE" ], "enumDescriptions": [ -"", +"Default value, unused.", "Preemption history.", "Price history." ], @@ -69923,6 +69931,25 @@ false }, "type": "object" }, +"DynamicCompressionPolicy": { +"description": "Dynamic compression policy for this URL Map's route.", +"id": "DynamicCompressionPolicy", +"properties": { +"compressionMode": { +"description": "Compress text responses using Brotli or gzip compression, based on\nthe client's Accept-Encoding header.", +"enum": [ +"AUTOMATIC", +"DISABLED" +], +"enumDescriptions": [ +"Automatically uses the best compression based on the Accept-Encoding\nheader sent by the client.", +"Disables compression. Existing compressed responses cached by\nCloud CDN will not be served to clients." +], +"type": "string" +} +}, +"type": "object" +}, "ErrorInfo": { "description": "Describes the cause of the error with structured details.\n\nExample of an error when contacting the \"pubsub.googleapis.com\" API when it\nis not enabled:\n\n { \"reason\": \"API_DISABLED\"\n \"domain\": \"googleapis.com\"\n \"metadata\": {\n \"resource\": \"projects/123\",\n \"service\": \"pubsub.googleapis.com\"\n }\n }\n\nThis response indicates that the pubsub.googleapis.com API is not enabled.\n\nExample of an error that is returned when attempting to create a Spanner\ninstance in a region that is out of stock:\n\n { \"reason\": \"STOCKOUT\"\n \"domain\": \"spanner.googleapis.com\",\n \"metadata\": {\n \"availableRegions\": \"us-central1,us-east2\"\n }\n }", "id": "ErrorInfo", @@ -72215,6 +72242,10 @@ false "description": "This field is not used for global external load balancing.\n\nFor internal passthrough Network Load Balancers, this field identifies the\nnetwork that the load balanced IP should belong to for this forwarding\nrule.\nIf the subnetwork is specified, the network of the subnetwork will be used.\nIf neither subnetwork nor this field is specified, the default network will\nbe used.\n\nFor Private Service Connect forwarding rules that forward traffic to Google\nAPIs, a network must be provided.", "type": "string" }, +"networkAttachment": { +"description": "Optional. The URL of the network attachment that this resource\nbelongs to.projects/{project}/regions/{region_name}/networkAttachments/{network_attachment_name}.", +"type": "string" +}, "networkTier": { "description": "This signifies the networking tier used for configuring\nthis load balancer and can only take the following values:PREMIUM, STANDARD.\n\nFor regional ForwardingRule, the valid values are PREMIUM andSTANDARD. For GlobalForwardingRule, the valid value isPREMIUM.\n\nIf this field is not specified, it is assumed to be PREMIUM.\nIf IPAddress is specified, this value must be equal to the\nnetworkTier of the Address.", "enum": [ @@ -72294,6 +72325,10 @@ false "readOnly": true, "type": "string" }, +"serviceClassId": { +"description": "Optional. Producer Service's Service class ID for the region of this forwarding rule.\nCan only be used with network_attachment. It is not possible to use on its\nown; however, network_attachment can be used without service_class_id.", +"type": "string" +}, "serviceDirectoryRegistrations": { "description": "Service Directory resources to register this forwarding rule with.\nCurrently, only supports a single Service Directory resource.", "items": { @@ -75307,6 +75342,7 @@ false "description": "The ID of a supported feature. To add multiple values, use commas to\nseparate values. Set to one or more of the following values:\n \n - VIRTIO_SCSI_MULTIQUEUE\n - WINDOWS\n - MULTI_IP_SUBNET\n - UEFI_COMPATIBLE\n - GVNIC\n - SEV_CAPABLE\n - SUSPEND_RESUME_COMPATIBLE\n - SEV_LIVE_MIGRATABLE_V2\n - SEV_SNP_CAPABLE\n - TDX_CAPABLE\n - IDPF\n - SNP_SVSM_CAPABLE\n - CCA_CAPABLE\n - SUSPEND_SAFE_FPR\n\n\nFor more information, see\nEnabling guest operating system features.", "enum": [ "BARE_METAL_LINUX_COMPATIBLE", +"BMSAI_CAPABLE", "CCA_CAPABLE", "FEATURE_TYPE_UNSPECIFIED", "GVNIC", @@ -75326,6 +75362,7 @@ false ], "enumDescriptions": [ "", +"Indicates the guest OS is capable of Bare Metal Secure AI (BMSAI)\nconfidential computing.", "", "", "", @@ -79827,6 +79864,10 @@ false "$ref": "CorsPolicy", "description": "The specification for allowing client-side cross-origin requests. For more\ninformation about the W3C recommendation for cross-origin resource sharing\n(CORS), see Fetch API Living\nStandard.\n\nNot supported when the URL map is bound to a target gRPC proxy." }, +"dynamicCompressionPolicy": { +"$ref": "DynamicCompressionPolicy", +"description": "Dynamic compression policy for this URL Map's route. Available only for\nGlobal EXTERNAL_MANAGED load balancer schemes." +}, "faultInjectionPolicy": { "$ref": "HttpFaultInjection", "description": "The specification for fault injection introduced into traffic to test\nthe resiliency of clients to backend service failure. As part of fault\ninjection, when clients send requests to a backend service, delays can be\nintroduced by a load balancer on a percentage of requests before sending\nthose requests to the backend service. Similarly requests from clients can\nbe aborted by the load balancer for a percentage of requests.timeout and retry_policy is ignored by clients\nthat are configured with a fault_injection_policy if:\n1. The traffic is generated by fault injection AND\n2. The fault injection is not a delay fault injection.\nFault injection is not supported with the classic Application Load Balancer\n. To see which load balancers support fault injection,\nsee Load\nbalancing: Routing and traffic management features." @@ -95941,6 +95982,14 @@ false "pattern": "[0-9]{1,3}(?:\\.[0-9]{1,3}){3}/[0-9]{1,2}", "type": "string" }, +"additionalTags": { +"description": "Output only. [Output Only] Additional tags for this resource.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "autoCreateSubnetworks": { "description": "Must be set to create a VPC network. If not set, a legacy network is\ncreated.\n\nWhen set to true, the VPC network is created in auto mode.\nWhen set to false, the VPC network is created in custom mode.\n\nAn auto mode VPC network starts with one subnet per region. Each subnet\nhas a predetermined range as described inAuto mode VPC network IP ranges.\n\nFor custom mode VPC networks, you can add subnets using the subnetworksinsert\nmethod.", "type": "boolean" @@ -115179,6 +115228,11 @@ false "description": "[Output Only] The ID of the host on which the running instance is located.\nInstances on the same host experience the lowest possible network\nlatency.", "type": "string" }, +"machine": { +"description": "Output only. [Output Only] The ID of the machine on which the running instance is\nlocated. It is only populated for machines which have multiple hosts.", +"readOnly": true, +"type": "string" +}, "subblock": { "description": "[Output Only] The ID of the sub-block in which the running instance is\nlocated. Instances in the same sub-block experience lower network latency\nthan instances in the same block.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/compute.beta.json b/googleapiclient/discovery_cache/documents/compute.beta.json index c9351e7cc1..e13462f745 100644 --- a/googleapiclient/discovery_cache/documents/compute.beta.json +++ b/googleapiclient/discovery_cache/documents/compute.beta.json @@ -966,6 +966,43 @@ "https://www.googleapis.com/auth/compute" ] }, +"calendarModeExtension": { +"description": "Advises on whether extending an existing future reservation is possible\nbased on the desired extension end time. If capacity isn't available for\nthe entire requested duration, the method recommends the longest possible\nextension.", +"flatPath": "projects/{project}/regions/{region}/advice/calendarModeExtension", +"httpMethod": "POST", +"id": "compute.advice.calendarModeExtension", +"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" +} +}, +"path": "projects/{project}/regions/{region}/advice/calendarModeExtension", +"request": { +"$ref": "CalendarModeExtensionAdviceRequest" +}, +"response": { +"$ref": "CalendarModeExtensionAdviceResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, "capacity": { "description": "Advice on making real-time decisions (such as choosing zone or\nmachine types) during deployment to maximize your chances of obtaining\ncapacity.", "flatPath": "projects/{project}/regions/{region}/advice/capacity", @@ -38891,6 +38928,55 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, +"getIamPolicy": { +"description": "Gets the access control policy for a resource. May be empty if no such\npolicy or resource exists.", +"flatPath": "projects/{project}/regions/{region}/sslPolicies/{resource}/getIamPolicy", +"httpMethod": "GET", +"id": "compute.regionSslPolicies.getIamPolicy", +"parameterOrder": [ +"project", +"region", +"resource" +], +"parameters": { +"optionsRequestedPolicyVersion": { +"description": "Requested IAM Policy version.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "The name of the region for this request.", +"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}/sslPolicies/{resource}/getIamPolicy", +"response": { +"$ref": "Policy" +}, +"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 and region using the data\nincluded in the request.", "flatPath": "projects/{project}/regions/{region}/sslPolicies", @@ -39108,6 +39194,51 @@ "https://www.googleapis.com/auth/compute" ] }, +"setIamPolicy": { +"description": "Sets the access control policy on the specified resource.\nReplaces any existing policy.", +"flatPath": "projects/{project}/regions/{region}/sslPolicies/{resource}/setIamPolicy", +"httpMethod": "POST", +"id": "compute.regionSslPolicies.setIamPolicy", +"parameterOrder": [ +"project", +"region", +"resource" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "The name of the region for this request.", +"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}/sslPolicies/{resource}/setIamPolicy", +"request": { +"$ref": "RegionSetPolicyRequest" +}, +"response": { +"$ref": "Policy" +}, +"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}/sslPolicies/{resource}/testIamPermissions", @@ -47217,6 +47348,47 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, +"getIamPolicy": { +"description": "Gets the access control policy for a resource. May be empty if no such\npolicy or resource exists.", +"flatPath": "projects/{project}/global/sslPolicies/{resource}/getIamPolicy", +"httpMethod": "GET", +"id": "compute.sslPolicies.getIamPolicy", +"parameterOrder": [ +"project", +"resource" +], +"parameters": { +"optionsRequestedPolicyVersion": { +"description": "Requested IAM Policy version.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"resource": { +"description": "Name or id of the resource for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/global/sslPolicies/{resource}/getIamPolicy", +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, "insert": { "description": "Returns the specified SSL policy resource.", "flatPath": "projects/{project}/global/sslPolicies", @@ -47402,6 +47574,43 @@ "https://www.googleapis.com/auth/compute" ] }, +"setIamPolicy": { +"description": "Sets the access control policy on the specified resource.\nReplaces any existing policy.", +"flatPath": "projects/{project}/global/sslPolicies/{resource}/setIamPolicy", +"httpMethod": "POST", +"id": "compute.sslPolicies.setIamPolicy", +"parameterOrder": [ +"project", +"resource" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"resource": { +"description": "Name or id of the resource for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/global/sslPolicies/{resource}/setIamPolicy", +"request": { +"$ref": "GlobalSetPolicyRequest" +}, +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, "testIamPermissions": { "description": "Returns permissions that a caller has on the specified resource.", "flatPath": "projects/{project}/global/sslPolicies/{resource}/testIamPermissions", @@ -54071,7 +54280,7 @@ } } }, -"revision": "20260821", +"revision": "20260828", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -55456,6 +55665,18 @@ false "description": "An alias IP range attached to an instance's network interface.", "id": "AliasIpRange", "properties": { +"candidateSubnetworkRangeNames": { +"description": "Identifies the candidate subnetwork range names for the alias\nIPs to be allocated from. When it is set, the IP would be allocated from\nany subnetwork range defined here if the IPs are available.\nOnly one of subnetwork_range_name or candidate_subnetwork_range_names\nshould be set.", +"items": { +"type": "string" +}, +"type": "array" +}, +"effectiveSubnetworkRangeName": { +"description": "Output only. [Output Only] The subnetwork range name where the IP is allocated.\nIt will be set to the subnetwork range where the IP is allocated only.", +"readOnly": true, +"type": "string" +}, "ipCidrRange": { "description": "The IP alias ranges to allocate for this interface. This IP CIDR range\nmust belong to the specified subnetwork and cannot contain IP addresses\nreserved by system or used by other network interfaces. This range may be\na single IP address (such as 10.2.3.4), a netmask (such as/24) or a CIDR-formatted string (such as10.1.2.0/24).", "type": "string" @@ -58791,7 +59012,7 @@ false "id": "BackendServiceHAPolicyLeaderNetworkEndpoint", "properties": { "instance": { -"description": "The name of the VM instance of the leader network endpoint. The\ninstance must already be attached to the NEG specified in the\nhaPolicy.leader.backendGroup.\n\nThe name must be 1-63 characters long, and comply with RFC1035.\nAuthorization requires the following IAM permission on the\nspecified resource instance: compute.instances.use", +"description": "The name of the VM instance of the leader network endpoint. The\ninstance must already be attached to the NEG specified in the\nhaPolicy.leader.backendGroup.\n\nThe value must be a valid RFC1035 name (1-63 characters) or a valid\ninstance URL.\nAuthorization requires the following IAM permission on the\nspecified resource instance: compute.instances.use", "type": "string" } }, @@ -60302,6 +60523,67 @@ false }, "type": "object" }, +"CalendarModeExtensionAdviceRequest": { +"description": "A request to recommend the maximum duration for extending an existing future\nreservation in calendar mode. The recommended duration is shorter than or\nequal to the specified extension duration.", +"id": "CalendarModeExtensionAdviceRequest", +"properties": { +"endTimeNotLaterThan": { +"description": "Required. The desired end time for the extension.", +"format": "google-datetime", +"type": "string" +}, +"futureReservation": { +"description": "Required. Reference to the future reservation, in the format:\nprojects/{project}/zones/{zone}/futureReservations/{name}\nFull URIs that include hostnames (like compute.googleapis.com or\nwww.googleapis.com) are also supported.", +"type": "string" +} +}, +"type": "object" +}, +"CalendarModeExtensionAdviceResponse": { +"description": "A response that contains the recommended duration for extending\na future reservation in calendar mode based on available capacity\nduring the extension period.", +"id": "CalendarModeExtensionAdviceResponse", +"properties": { +"endTime": { +"description": "The recommended end time for the extension, which is either the end time\nrequested by the caller or the longest alternative with sufficient\ncapacity. If the extension is not possible, this field is empty, and\nnotRecommendedReason is populated instead.", +"format": "google-datetime", +"type": "string" +}, +"notRecommendedReason": { +"$ref": "CalendarModeExtensionAdviceResponseNotRecommendedReason", +"description": "The reason why the future reservation can't be extended. If a\nrecommendation is provided, whether for the requested end time or an\nalternative, this field is empty." +}, +"recommendationId": { +"description": "The unique ID of the recommendation, which is a UUID string generated by\nthe API.", +"type": "string" +} +}, +"type": "object" +}, +"CalendarModeExtensionAdviceResponseNotRecommendedReason": { +"description": "Information about why no recommendation was provided.", +"id": "CalendarModeExtensionAdviceResponseNotRecommendedReason", +"properties": { +"details": { +"description": "Human-readable details describing why the recommendation wasn't provided.\nFor example, if the status is CONDITIONS_NOT_MET, this field explains why\nthe requested extension duration isn't possible.", +"type": "string" +}, +"status": { +"description": "Status of recommendation.", +"enum": [ +"CONDITIONS_NOT_MET", +"NOT_RECOMMENDED_REASON_STATUS_UNSPECIFIED", +"NO_CAPACITY" +], +"enumDescriptions": [ +"The requested extension window doesn't meet the\nrequired conditions.", +"Default value, unused.", +"There is no available capacity for the extension to be provided." +], +"type": "string" +} +}, +"type": "object" +}, "CalendarModeRecommendation": { "description": "A single recommendation to create requested resources. Contains detailed\nrecommendations for every future resources specification specified in\nCalendarModeAdviceRequest.", "id": "CalendarModeRecommendation", @@ -60356,7 +60638,7 @@ false "Picks zones for creating VM instances to fulfill the requested number\nof VMs within present resource constraints.", "Creates all VM instances within a single zone. The zone is selected\nbased on the present resource constraints.", "Prioritizes acquisition of resources, scheduling VMs in zones where\nresources are available while distributing VMs as evenly as possible\nacross selected zones to minimize the impact of zonal failure.", -"" +"Default value, unused." ], "type": "string" }, @@ -60583,7 +60865,7 @@ false "PRICE" ], "enumDescriptions": [ -"", +"Default value, unused.", "Preemption history.", "Price history." ], @@ -64585,6 +64867,25 @@ false }, "type": "object" }, +"DynamicCompressionPolicy": { +"description": "Dynamic compression policy for this URL Map's route.", +"id": "DynamicCompressionPolicy", +"properties": { +"compressionMode": { +"description": "Compress text responses using Brotli or gzip compression, based on\nthe client's Accept-Encoding header.", +"enum": [ +"AUTOMATIC", +"DISABLED" +], +"enumDescriptions": [ +"Automatically uses the best compression based on the Accept-Encoding\nheader sent by the client.", +"Disables compression. Existing compressed responses cached by\nCloud CDN will not be served to clients." +], +"type": "string" +} +}, +"type": "object" +}, "ErrorInfo": { "description": "Describes the cause of the error with structured details.\n\nExample of an error when contacting the \"pubsub.googleapis.com\" API when it\nis not enabled:\n\n { \"reason\": \"API_DISABLED\"\n \"domain\": \"googleapis.com\"\n \"metadata\": {\n \"resource\": \"projects/123\",\n \"service\": \"pubsub.googleapis.com\"\n }\n }\n\nThis response indicates that the pubsub.googleapis.com API is not enabled.\n\nExample of an error that is returned when attempting to create a Spanner\ninstance in a region that is out of stock:\n\n { \"reason\": \"STOCKOUT\"\n \"domain\": \"spanner.googleapis.com\",\n \"metadata\": {\n \"availableRegions\": \"us-central1,us-east2\"\n }\n }", "id": "ErrorInfo", @@ -69339,6 +69640,7 @@ false "description": "The ID of a supported feature. To add multiple values, use commas to\nseparate values. Set to one or more of the following values:\n \n - VIRTIO_SCSI_MULTIQUEUE\n - WINDOWS\n - MULTI_IP_SUBNET\n - UEFI_COMPATIBLE\n - GVNIC\n - SEV_CAPABLE\n - SUSPEND_RESUME_COMPATIBLE\n - SEV_LIVE_MIGRATABLE_V2\n - SEV_SNP_CAPABLE\n - TDX_CAPABLE\n - IDPF\n - SNP_SVSM_CAPABLE\n - CCA_CAPABLE\n - SUSPEND_SAFE_FPR\n\n\nFor more information, see\nEnabling guest operating system features.", "enum": [ "BARE_METAL_LINUX_COMPATIBLE", +"BMSAI_CAPABLE", "CCA_CAPABLE", "FEATURE_TYPE_UNSPECIFIED", "GVNIC", @@ -69358,6 +69660,7 @@ false ], "enumDescriptions": [ "", +"Indicates the guest OS is capable of Bare Metal Secure AI (BMSAI)\nconfidential computing.", "", "", "", @@ -72821,6 +73124,10 @@ false "$ref": "CorsPolicy", "description": "The specification for allowing client-side cross-origin requests. For more\ninformation about the W3C recommendation for cross-origin resource sharing\n(CORS), see Fetch API Living\nStandard.\n\nNot supported when the URL map is bound to a target gRPC proxy." }, +"dynamicCompressionPolicy": { +"$ref": "DynamicCompressionPolicy", +"description": "Dynamic compression policy for this URL Map's route. Available only for\nGlobal EXTERNAL_MANAGED load balancer schemes." +}, "faultInjectionPolicy": { "$ref": "HttpFaultInjection", "description": "The specification for fault injection introduced into traffic to test\nthe resiliency of clients to backend service failure. As part of fault\ninjection, when clients send requests to a backend service, delays can be\nintroduced by a load balancer on a percentage of requests before sending\nthose requests to the backend service. Similarly requests from clients can\nbe aborted by the load balancer for a percentage of requests.timeout and retry_policy is ignored by clients\nthat are configured with a fault_injection_policy if:\n1. The traffic is generated by fault injection AND\n2. The fault injection is not a delay fault injection.\nFault injection is not supported with the classic Application Load Balancer\n. To see which load balancers support fault injection,\nsee Load\nbalancing: Routing and traffic management features." @@ -78246,6 +78553,10 @@ false "description": "Represents the change that you want to make to the instance properties.", "id": "InstancePropertiesPatch", "properties": { +"exposeHostTopology": { +"description": "This optional flag exposes the hashed physical host ID.", +"type": "boolean" +}, "labels": { "additionalProperties": { "type": "string" @@ -83438,6 +83749,10 @@ false "description": "If set to true, the Interconnect connection is configured with ashould-secure MACsec security policy, that allows the Google\nrouter to fallback to cleartext traffic if the MKA session cannot be\nestablished. By default, the Interconnect connection is configured with amust-secure security policy that drops all traffic if the\nMKA session cannot be established with your router.", "type": "boolean" }, +"interconnectKeyGroup": { +"description": "Optional. URL of the InterconnectKeyGroup resource to use for MACsec, in the\nformat:\nprojects/{project}/locations/{region}/interconnectKeyGroups/{interconnectKeyGroup}.", +"type": "string" +}, "preSharedKeys": { "description": "Required. A keychain placeholder describing a set of named key objects\nalong with their start times. A MACsec CKN/CAK is generated for each\nkey in the key chain. Google router automatically picks the key with\nthe most recent startTime when establishing or re-establishing a MACsec\nsecure link.", "items": { @@ -104462,6 +104777,11 @@ false "description": "[Output Only] The ID of the host on which the running instance is located.\nInstances on the same host experience the lowest possible network\nlatency.", "type": "string" }, +"machine": { +"description": "Output only. [Output Only] The ID of the machine on which the running instance is\nlocated. It is only populated for machines which have multiple hosts.", +"readOnly": true, +"type": "string" +}, "subblock": { "description": "[Output Only] The ID of the sub-block in which the running instance is\nlocated. Instances in the same sub-block experience lower network latency\nthan instances in the same block.", "type": "string" @@ -108436,6 +108756,10 @@ false "format": "int32", "type": "integer" }, +"exposeHostTopology": { +"description": "This optional flag exposes the hashed physical host ID in the\nResourceStatus resource of the VM.", +"type": "boolean" +}, "gracefulShutdown": { "$ref": "SchedulingGracefulShutdown" }, From c70e042a83fef2c124600de936f2f6068250f24e Mon Sep 17 00:00:00 2001 From: Yoshi AutomationDate: Tue, 8 Sep 2026 07:20:13 +0000 Subject: [PATCH 16/40] feat(contactcenterinsights): update the api #### contactcenterinsights:v1 The following keys were added: - schemas.GoogleCloudCesV1mainImage.properties.altText.type (Total Keys: 1) --- ...iewSets.authorizedViews.conversations.html | 4 ++ ....projects.locations.autoLabelingRules.html | 1 + ...s_v1.projects.locations.conversations.html | 9 ++++ ...ects.locations.datasets.conversations.html | 4 ++ ...tcenterinsights_v1.projects.locations.html | 1 + .../documents/contactcenterinsights.v1.json | 48 +++++++++++++------ 6 files changed, 52 insertions(+), 15 deletions(-) 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 f4cc8d5758..ffaf29dba7 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.html @@ -219,6 +219,7 @@ Method Details
CONVERSATION_VIEW_UNSPECIFIED - The conversation view is not specified. * Defaults to `FULL` in `GetConversationRequest`. * Defaults to `BASIC` in `ListConversationsRequest`. FULL - Populates all fields in the conversation. BASIC - Populates all fields in the conversation except the transcript. + FULL_WITH_STRUCTURED_TRANSCRIPT - Populates all fields in the conversation, including the structured transcript parts. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -582,6 +583,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -841,6 +843,7 @@Method Details
CONVERSATION_VIEW_UNSPECIFIED - The conversation view is not specified. * Defaults to `FULL` in `GetConversationRequest`. * Defaults to `BASIC` in `ListConversationsRequest`. FULL - Populates all fields in the conversation. BASIC - Populates all fields in the conversation except the transcript. + FULL_WITH_STRUCTURED_TRANSCRIPT - Populates all fields in the conversation, including the structured transcript parts. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -1206,6 +1209,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.autoLabelingRules.html b/docs/dyn/contactcenterinsights_v1.projects.locations.autoLabelingRules.html index b61d752975..0e04031b3f 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.autoLabelingRules.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.autoLabelingRules.html @@ -694,6 +694,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.html b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.html index f09f481003..adc0a0e511 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.html @@ -673,6 +673,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -1280,6 +1281,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -1585,6 +1587,7 @@Method Details
CONVERSATION_VIEW_UNSPECIFIED - The conversation view is not specified. * Defaults to `FULL` in `GetConversationRequest`. * Defaults to `BASIC` in `ListConversationsRequest`. FULL - Populates all fields in the conversation. BASIC - Populates all fields in the conversation except the transcript. + FULL_WITH_STRUCTURED_TRANSCRIPT - Populates all fields in the conversation, including the structured transcript parts. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -1948,6 +1951,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -2276,6 +2280,7 @@Method Details
CONVERSATION_VIEW_UNSPECIFIED - The conversation view is not specified. * Defaults to `FULL` in `GetConversationRequest`. * Defaults to `BASIC` in `ListConversationsRequest`. FULL - Populates all fields in the conversation. BASIC - Populates all fields in the conversation except the transcript. + FULL_WITH_STRUCTURED_TRANSCRIPT - Populates all fields in the conversation, including the structured transcript parts. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -2641,6 +2646,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -3266,6 +3272,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -3875,6 +3882,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -4541,6 +4549,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.conversations.html b/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.conversations.html index 2d4ede45fb..5cf96c16ad 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.conversations.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.conversations.html @@ -274,6 +274,7 @@Method Details
CONVERSATION_VIEW_UNSPECIFIED - The conversation view is not specified. * Defaults to `FULL` in `GetConversationRequest`. * Defaults to `BASIC` in `ListConversationsRequest`. FULL - Populates all fields in the conversation. BASIC - Populates all fields in the conversation except the transcript. + FULL_WITH_STRUCTURED_TRANSCRIPT - Populates all fields in the conversation, including the structured transcript parts. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -637,6 +638,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, @@ -965,6 +967,7 @@Method Details
CONVERSATION_VIEW_UNSPECIFIED - The conversation view is not specified. * Defaults to `FULL` in `GetConversationRequest`. * Defaults to `BASIC` in `ListConversationsRequest`. FULL - Populates all fields in the conversation. BASIC - Populates all fields in the conversation except the transcript. + FULL_WITH_STRUCTURED_TRANSCRIPT - Populates all fields in the conversation, including the structured transcript parts. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -1330,6 +1333,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.html b/docs/dyn/contactcenterinsights_v1.projects.locations.html index 94ea9bda42..6cdb04dfb3 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.html @@ -1112,6 +1112,7 @@Method Details
"a_key": "", # Properties of the object. }, "image": { # Represents an image input or output in the conversation. # Optional. Image data. + "altText": "A String", # Optional. The alternative text for the image. "data": "A String", # Required. Raw bytes of the image. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. Supported image types includes: * image/png * image/jpeg * image/webp }, diff --git a/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json b/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json index 764b419353..63c933e201 100644 --- a/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json +++ b/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json @@ -1595,12 +1595,14 @@ "enum": [ "CONVERSATION_VIEW_UNSPECIFIED", "FULL", -"BASIC" +"BASIC", +"FULL_WITH_STRUCTURED_TRANSCRIPT" ], "enumDescriptions": [ "The conversation view is not specified. * Defaults to `FULL` in `GetConversationRequest`. * Defaults to `BASIC` in `ListConversationsRequest`.", "Populates all fields in the conversation.", -"Populates all fields in the conversation except the transcript." +"Populates all fields in the conversation except the transcript.", +"Populates all fields in the conversation, including the structured transcript parts." ], "location": "query", "type": "string" @@ -1656,12 +1658,14 @@ "enum": [ "CONVERSATION_VIEW_UNSPECIFIED", "FULL", -"BASIC" +"BASIC", +"FULL_WITH_STRUCTURED_TRANSCRIPT" ], "enumDescriptions": [ "The conversation view is not specified. * Defaults to `FULL` in `GetConversationRequest`. * Defaults to `BASIC` in `ListConversationsRequest`.", "Populates all fields in the conversation.", -"Populates all fields in the conversation except the transcript." +"Populates all fields in the conversation except the transcript.", +"Populates all fields in the conversation, including the structured transcript parts." ], "location": "query", "type": "string" @@ -2668,12 +2672,14 @@ "enum": [ "CONVERSATION_VIEW_UNSPECIFIED", "FULL", -"BASIC" +"BASIC", +"FULL_WITH_STRUCTURED_TRANSCRIPT" ], "enumDescriptions": [ "The conversation view is not specified. * Defaults to `FULL` in `GetConversationRequest`. * Defaults to `BASIC` in `ListConversationsRequest`.", "Populates all fields in the conversation.", -"Populates all fields in the conversation except the transcript." +"Populates all fields in the conversation except the transcript.", +"Populates all fields in the conversation, including the structured transcript parts." ], "location": "query", "type": "string" @@ -2757,12 +2763,14 @@ "enum": [ "CONVERSATION_VIEW_UNSPECIFIED", "FULL", -"BASIC" +"BASIC", +"FULL_WITH_STRUCTURED_TRANSCRIPT" ], "enumDescriptions": [ "The conversation view is not specified. * Defaults to `FULL` in `GetConversationRequest`. * Defaults to `BASIC` in `ListConversationsRequest`.", "Populates all fields in the conversation.", -"Populates all fields in the conversation except the transcript." +"Populates all fields in the conversation except the transcript.", +"Populates all fields in the conversation, including the structured transcript parts." ], "location": "query", "type": "string" @@ -4274,12 +4282,14 @@ "enum": [ "CONVERSATION_VIEW_UNSPECIFIED", "FULL", -"BASIC" +"BASIC", +"FULL_WITH_STRUCTURED_TRANSCRIPT" ], "enumDescriptions": [ "The conversation view is not specified. * Defaults to `FULL` in `GetConversationRequest`. * Defaults to `BASIC` in `ListConversationsRequest`.", "Populates all fields in the conversation.", -"Populates all fields in the conversation except the transcript." +"Populates all fields in the conversation except the transcript.", +"Populates all fields in the conversation, including the structured transcript parts." ], "location": "query", "type": "string" @@ -4363,12 +4373,14 @@ "enum": [ "CONVERSATION_VIEW_UNSPECIFIED", "FULL", -"BASIC" +"BASIC", +"FULL_WITH_STRUCTURED_TRANSCRIPT" ], "enumDescriptions": [ "The conversation view is not specified. * Defaults to `FULL` in `GetConversationRequest`. * Defaults to `BASIC` in `ListConversationsRequest`.", "Populates all fields in the conversation.", -"Populates all fields in the conversation except the transcript." +"Populates all fields in the conversation except the transcript.", +"Populates all fields in the conversation, including the structured transcript parts." ], "location": "query", "type": "string" @@ -6236,7 +6248,7 @@ } } }, -"revision": "20260825", +"revision": "20260902", "rootUrl": "https://contactcenterinsights.googleapis.com/", "schemas": { "GoogleCloudCesV1mainAgentTransfer": { @@ -6349,6 +6361,10 @@ "description": "Represents an image input or output in the conversation.", "id": "GoogleCloudCesV1mainImage", "properties": { +"altText": { +"description": "Optional. The alternative text for the image.", +"type": "string" +}, "data": { "description": "Required. Raw bytes of the image.", "format": "byte", @@ -12144,12 +12160,14 @@ true "enum": [ "PREDEFINED_QUESTION_TYPE_UNSPECIFIED", "CONVERSATION_OUTCOME", -"CONVERSATION_OUTCOME_ESCALATION_INITIATOR_ROLE" +"CONVERSATION_OUTCOME_ESCALATION_INITIATOR_ROLE", +"CONVERSATION_OUTCOME_AI_AVERSION" ], "enumDescriptions": [ "The type of the predefined question is unspecified.", "A prebuilt classifier classfying the outcome of the conversation. For example, if the customer issue mentioned in a conversation has been resolved or not.", -"A prebuilt classifier classfying the initiator of the conversation escalation. For example, if it was initiated by the customer or the agent." +"A prebuilt classifier classfying the initiator of the conversation escalation. For example, if it was initiated by the customer or the agent.", +"Classifies whether the customer demonstrates AI aversion by instantly requesting escalation to a human agent without attempting to work with the AI agent." ], "type": "string" } From 5b904fcf649f1820491f63fea2b0b1e84faaded9 Mon Sep 17 00:00:00 2001 From: Yoshi AutomationDate: Tue, 8 Sep 2026 07:20:13 +0000 Subject: [PATCH 17/40] feat(containeranalysis): update the api #### containeranalysis:v1 The following keys were added: - schemas.MaliciousContentLLMResult.properties.tokenUsage.$ref (Total Keys: 1) - schemas.TokenUsage (Total Keys: 12) #### containeranalysis:v1alpha1 The following keys were added: - schemas.MaliciousContentLLMResult.properties.tokenUsage (Total Keys: 2) - schemas.TokenUsage (Total Keys: 17) #### containeranalysis:v1beta1 The following keys were added: - schemas.MaliciousContentLLMResult.properties.tokenUsage.$ref (Total Keys: 1) - schemas.TokenUsage (Total Keys: 12) --- ....projects.locations.notes.occurrences.html | 7 +++ ...sis_v1.projects.locations.occurrences.html | 56 +++++++++++++++++++ ...nalysis_v1.projects.notes.occurrences.html | 7 +++ ...aineranalysis_v1.projects.occurrences.html | 56 +++++++++++++++++++ ...s_v1alpha1.projects.notes.occurrences.html | 7 +++ ...nalysis_v1alpha1.projects.occurrences.html | 42 ++++++++++++++ ..._v1alpha1.providers.notes.occurrences.html | 7 +++ ....projects.locations.notes.occurrences.html | 7 +++ ...1beta1.projects.locations.occurrences.html | 56 +++++++++++++++++++ ...is_v1beta1.projects.notes.occurrences.html | 7 +++ ...analysis_v1beta1.projects.occurrences.html | 56 +++++++++++++++++++ .../documents/containeranalysis.v1.json | 38 ++++++++++++- .../documents/containeranalysis.v1alpha1.json | 44 ++++++++++++++- .../documents/containeranalysis.v1beta1.json | 38 ++++++++++++- 14 files changed, 425 insertions(+), 3 deletions(-) diff --git a/docs/dyn/containeranalysis_v1.projects.locations.notes.occurrences.html b/docs/dyn/containeranalysis_v1.projects.locations.notes.occurrences.html index f392174d9c..8274e9d870 100644 --- a/docs/dyn/containeranalysis_v1.projects.locations.notes.occurrences.html +++ b/docs/dyn/containeranalysis_v1.projects.locations.notes.occurrences.html @@ -130,6 +130,13 @@ Method Details
"maxSeverity": "A String", # Tracks max severity found. "modelId": "A String", # The base name of the model that performed the scan. "scanStatus": "A String", # Status of the scan. + "tokenUsage": { # Token usage associated with an AI scan. # Telemetry metrics tracking token usage for the AI scan. + "cacheCount": "A String", # Cache matched tokens for implicit cache. + "candidateCount": "A String", # Tokens in the model response. + "promptCount": "A String", # Tokens in the user request. + "thinkingCount": "A String", # Tokens in the thinking output. + "toolUsePromptCount": "A String", # Prompt tokens for using tools. + }, }, "maliciousContentStaticResult": { # Result of Malicious Content Static scan. # Malicious Content Static scan result. "maxSeverity": "A String", # Tracks max severity found. diff --git a/docs/dyn/containeranalysis_v1.projects.locations.occurrences.html b/docs/dyn/containeranalysis_v1.projects.locations.occurrences.html index baaff28c34..af3a52297f 100644 --- a/docs/dyn/containeranalysis_v1.projects.locations.occurrences.html +++ b/docs/dyn/containeranalysis_v1.projects.locations.occurrences.html @@ -146,6 +146,13 @@Method Details
"maxSeverity": "A String", # Tracks max severity found. "modelId": "A String", # The base name of the model that performed the scan. "scanStatus": "A String", # Status of the scan. + "tokenUsage": { # Token usage associated with an AI scan. # Telemetry metrics tracking token usage for the AI scan. + "cacheCount": "A String", # Cache matched tokens for implicit cache. + "candidateCount": "A String", # Tokens in the model response. + "promptCount": "A String", # Tokens in the user request. + "thinkingCount": "A String", # Tokens in the thinking output. + "toolUsePromptCount": "A String", # Prompt tokens for using tools. + }, }, "maliciousContentStaticResult": { # Result of Malicious Content Static scan. # Malicious Content Static scan result. "maxSeverity": "A String", # Tracks max severity found. @@ -1111,6 +1118,13 @@Method Details
"maxSeverity": "A String", # Tracks max severity found. "modelId": "A String", # The base name of the model that performed the scan. "scanStatus": "A String", # Status of the scan. + "tokenUsage": { # Token usage associated with an AI scan. # Telemetry metrics tracking token usage for the AI scan. + "cacheCount": "A String", # Cache matched tokens for implicit cache. + "candidateCount": "A String", # Tokens in the model response. + "promptCount": "A String", # Tokens in the user request. + "thinkingCount": "A String", # Tokens in the thinking output. + "toolUsePromptCount": "A String", # Prompt tokens for using tools. + }, }, "maliciousContentStaticResult": { # Result of Malicious Content Static scan. # Malicious Content Static scan result. "maxSeverity": "A String", # Tracks max severity found. @@ -2081,6 +2095,13 @@Method Details
"maxSeverity": "A String", # Tracks max severity found. "modelId": "A String", # The base name of the model that performed the scan. "scanStatus": "A String", # Status of the scan. + "tokenUsage": { # Token usage associated with an AI scan. # Telemetry metrics tracking token usage for the AI scan. + "cacheCount": "A String", # Cache matched tokens for implicit cache. + "candidateCount": "A String", # Tokens in the model response. + "promptCount": "A String", # Tokens in the user request. + "thinkingCount": "A String", # Tokens in the thinking output. + "toolUsePromptCount": "A String", # Prompt tokens for using tools. + }, }, "maliciousContentStaticResult": { # Result of Malicious Content Static scan. # Malicious Content Static scan result. "maxSeverity": "A String", # Tracks max severity found. @@ -3042,6 +3063,13 @@Method Details
"maxSeverity": "A String", # Tracks max severity found. "modelId": "A String", # The base name of the model that performed the scan. "scanStatus": "A String", # Status of the scan. + "tokenUsage": { # Token usage associated with an AI scan. # Telemetry metrics tracking token usage for the AI scan. + "cacheCount": "A String", # Cache matched tokens for implicit cache. + "candidateCount": "A String", # Tokens in the model response. + "promptCount": "A String", # Tokens in the user request. + "thinkingCount": "A String", # Tokens in the thinking output. + "toolUsePromptCount": "A String", # Prompt tokens for using tools. + }, }, "maliciousContentStaticResult": { # Result of Malicious Content Static scan. # Malicious Content Static scan result. "maxSeverity": "A String", # Tracks max severity found. @@ -4028,6 +4056,13 @@Method Details
"maxSeverity": "A String", # Tracks max severity found. "modelId": "A String", # The base name of the model that performed the scan. "scanStatus": "A String", # Status of the scan. + "tokenUsage": { # Token usage associated with an AI scan. # Telemetry metrics tracking token usage for the AI scan. + "cacheCount": "A String", # Cache matched tokens for implicit cache. + "candidateCount": "A String", # Tokens in the model response. + "promptCount": "A String", # Tokens in the user request. + "thinkingCount": "A String", # Tokens in the thinking output. + "toolUsePromptCount": "A String", # Prompt tokens for using tools. + }, }, "maliciousContentStaticResult": { # Result of Malicious Content Static scan. # Malicious Content Static scan result. "maxSeverity": "A String", # Tracks max severity found. @@ -5415,6 +5450,13 @@Method Details
"maxSeverity": "A String", # Tracks max severity found. "modelId": "A String", # The base name of the model that performed the scan. "scanStatus": "A String", # Status of the scan. + "tokenUsage": { # Token usage associated with an AI scan. # Telemetry metrics tracking token usage for the AI scan. + "cacheCount": "A String", # Cache matched tokens for implicit cache. + "candidateCount": "A String", # Tokens in the model response. + "promptCount": "A String", # Tokens in the user request. + "thinkingCount": "A String", # Tokens in the thinking output. + "toolUsePromptCount": "A String", # Prompt tokens for using tools. + }, }, "maliciousContentStaticResult": { # Result of Malicious Content Static scan. # Malicious Content Static scan result. "maxSeverity": "A String", # Tracks max severity found. @@ -6397,6 +6439,13 @@Method Details
"maxSeverity": "A String", # Tracks max severity found. "modelId": "A String", # The base name of the model that performed the scan. "scanStatus": "A String", # Status of the scan. + "tokenUsage": { # Token usage associated with an AI scan. # Telemetry metrics tracking token usage for the AI scan. + "cacheCount": "A String", # Cache matched tokens for implicit cache. + "candidateCount": "A String", # Tokens in the model response. + "promptCount": "A String", # Tokens in the user request. + "thinkingCount": "A String", # Tokens in the thinking output. + "toolUsePromptCount": "A String", # Prompt tokens for using tools. + }, }, "maliciousContentStaticResult": { # Result of Malicious Content Static scan. # Malicious Content Static scan result. "maxSeverity": "A String", # Tracks max severity found. @@ -7359,6 +7408,13 @@Method Details
"maxSeverity": "A String", # Tracks max severity found. "modelId": "A String", # The base name of the model that performed the scan. "scanStatus": "A String", # Status of the scan. + "tokenUsage": { # Token usage associated with an AI scan. # Telemetry metrics tracking token usage for the AI scan. + "cacheCount": "A String", # Cache matched tokens for implicit cache. + "candidateCount": "A String", # Tokens in the model response. + "promptCount": "A String", # Tokens in the user request. + "thinkingCount": "A String", # Tokens in the thinking output. + "toolUsePromptCount": "A String", # Prompt tokens for using tools. + }, }, "maliciousContentStaticResult": { # Result of Malicious Content Static scan. # Malicious Content Static scan result. "maxSeverity": "A String", # Tracks max severity found. diff --git a/docs/dyn/containeranalysis_v1.projects.notes.occurrences.html b/docs/dyn/containeranalysis_v1.projects.notes.occurrences.html index 3ec187bdd2..e2ce8ea190 100644 --- a/docs/dyn/containeranalysis_v1.projects.notes.occurrences.html +++ b/docs/dyn/containeranalysis_v1.projects.notes.occurrences.html @@ -130,6 +130,13 @@Method Details
"maxSeverity": "A String", # Tracks max severity found. "modelId": "A String", # The base name of the model that performed the scan. "scanStatus": "A String", # Status of the scan. + "tokenUsage": { # Token usage associated with an AI scan. # Telemetry metrics tracking token usage for the AI scan. + "cacheCount": "A String", # Cache matched tokens for implicit cache. + "candidateCount": "A String", # Tokens in the model response. + "promptCount": "A String", # Tokens in the user request. + "thinkingCount": "A String", # Tokens in the thinking output. + "toolUsePromptCount": "A String", # Prompt tokens for using tools. + }, }, "maliciousContentStaticResult": { # Result of Malicious Content Static scan. # Malicious Content Static scan result. "maxSeverity": "A String", # Tracks max severity found. diff --git a/docs/dyn/containeranalysis_v1.projects.occurrences.html b/docs/dyn/containeranalysis_v1.projects.occurrences.html index e25316fcae..129416df9e 100644 --- a/docs/dyn/containeranalysis_v1.projects.occurrences.html +++ b/docs/dyn/containeranalysis_v1.projects.occurrences.html @@ -146,6 +146,13 @@Method Details
"maxSeverity": "A String", # Tracks max severity found. "modelId": "A String", # The base name of the model that performed the scan. "scanStatus": "A String", # Status of the scan. + "tokenUsage": { # Token usage associated with an AI scan. # Telemetry metrics tracking token usage for the AI scan. + "cacheCount": "A String", # Cache matched tokens for implicit cache. + "candidateCount": "A String", # Tokens in the model response. + "promptCount": "A String", # Tokens in the user request. + "thinkingCount": "A String", # Tokens in the thinking output. + "toolUsePromptCount": "A String", # Prompt tokens for using tools. + }, }, "maliciousContentStaticResult": { # Result of Malicious Content Static scan. # Malicious Content Static scan result. "maxSeverity": "A String", # Tracks max severity found. @@ -1111,6 +1118,13 @@Method Details
"maxSeverity": "A String", # Tracks max severity found. "modelId": "A String", # The base name of the model that performed the scan. "scanStatus": "A String", # Status of the scan. + "tokenUsage": { # Token usage associated with an AI scan. # Telemetry metrics tracking token usage for the AI scan. + "cacheCount": "A String", # Cache matched tokens for implicit cache. + "candidateCount": "A String", # Tokens in the model response. + "promptCount": "A String", # Tokens in the user request. + "thinkingCount": "A String", # Tokens in the thinking output. + "toolUsePromptCount": "A String", # Prompt tokens for using tools. + }, }, "maliciousContentStaticResult": { # Result of Malicious Content Static scan. # Malicious Content Static scan result. "maxSeverity": "A String", # Tracks max severity found. @@ -2081,6 +2095,13 @@Method Details
"maxSeverity": "A String", # Tracks max severity found. "modelId": "A String", # The base name of the model that performed the scan. "scanStatus": "A String", # Status of the scan. + "tokenUsage": { # Token usage associated with an AI scan. # Telemetry metrics tracking token usage for the AI scan. + "cacheCount": "A String", # Cache matched tokens for implicit cache. + "candidateCount": "A String", # Tokens in the model response. + "promptCount": "A String", # Tokens in the user request. + "thinkingCount": "A String", # Tokens in the thinking output. + "toolUsePromptCount": "A String", # Prompt tokens for using tools. + }, }, "maliciousContentStaticResult": { # Result of Malicious Content Static scan. # Malicious Content Static scan result. "maxSeverity": "A String", # Tracks max severity found. @@ -3042,6 +3063,13 @@Method Details
"maxSeverity": "A String", # Tracks max severity found. "modelId": "A String", # The base name of the model that performed the scan. "scanStatus": "A String", # Status of the scan. + "tokenUsage": { # Token usage associated with an AI scan. # Telemetry metrics tracking token usage for the AI scan. + "cacheCount": "A String", # Cache matched tokens for implicit cache. + "candidateCount": "A String", # Tokens in the model response. + "promptCount": "A String", # Tokens in the user request. + "thinkingCount": "A String", # Tokens in the thinking output. + "toolUsePromptCount": "A String", # Prompt tokens for using tools. + }, }, "maliciousContentStaticResult": { # Result of Malicious Content Static scan. # Malicious Content Static scan result. "maxSeverity": "A String", # Tracks max severity found. @@ -4028,6 +4056,13 @@Method Details
"maxSeverity": "A String", # Tracks max severity found. "modelId": "A String", # The base name of the model that performed the scan. "scanStatus": "A String", # Status of the scan. + "tokenUsage": { # Token usage associated with an AI scan. # Telemetry metrics tracking token usage for the AI scan. + "cacheCount": "A String", # Cache matched tokens for implicit cache. + "candidateCount": "A String", # Tokens in the model response. + "promptCount": "A String", # Tokens in the user request. + "thinkingCount": "A String", # Tokens in the thinking output. + "toolUsePromptCount": "A String", # Prompt tokens for using tools. + }, }, "maliciousContentStaticResult": { # Result of Malicious Content Static scan. # Malicious Content Static scan result. "maxSeverity": "A String", # Tracks max severity found. @@ -5415,6 +5450,13 @@Method Details
"maxSeverity": "A String", # Tracks max severity found. "modelId": "A String", # The base name of the model that performed the scan. "scanStatus": "A String", # Status of the scan. + "tokenUsage": { # Token usage associated with an AI scan. # Telemetry metrics tracking token usage for the AI scan. + "cacheCount": "A String", # Cache matched tokens for implicit cache. + "candidateCount": "A String", # Tokens in the model response. + "promptCount": "A String", # Tokens in the user request. + "thinkingCount": "A String", # Tokens in the thinking output. + "toolUsePromptCount": "A String", # Prompt tokens for using tools. + }, }, "maliciousContentStaticResult": { # Result of Malicious Content Static scan. # Malicious Content Static scan result. "maxSeverity": "A String", # Tracks max severity found. @@ -6397,6 +6439,13 @@Method Details
"maxSeverity": "A String", # Tracks max severity found. "modelId": "A String", # The base name of the model that performed the scan. "scanStatus": "A String", # Status of the scan. + "tokenUsage": { # Token usage associated with an AI scan. # Telemetry metrics tracking token usage for the AI scan. + "cacheCount": "A String", # Cache matched tokens for implicit cache. + "candidateCount": "A String", # Tokens in the model response. + "promptCount": "A String", # Tokens in the user request. + "thinkingCount": "A String", # Tokens in the thinking output. + "toolUsePromptCount": "A String", # Prompt tokens for using tools. + }, }, "maliciousContentStaticResult": { # Result of Malicious Content Static scan. # Malicious Content Static scan result. "maxSeverity": "A String", # Tracks max severity found. @@ -7359,6 +7408,13 @@Method Details
"maxSeverity": "A String", # Tracks max severity found. "modelId": "A String", # The base name of the model that performed the scan. "scanStatus": "A String", # Status of the scan. + "tokenUsage": { # Token usage associated with an AI scan. # Telemetry metrics tracking token usage for the AI scan. + "cacheCount": "A String", # Cache matched tokens for implicit cache. + "candidateCount": "A String", # Tokens in the model response. + "promptCount": "A String", # Tokens in the user request. + "thinkingCount": "A String", # Tokens in the thinking output. + "toolUsePromptCount": "A String", # Prompt tokens for using tools. + }, }, "maliciousContentStaticResult": { # Result of Malicious Content Static scan. # Malicious Content Static scan result. "maxSeverity": "A String", # Tracks max severity found. diff --git a/docs/dyn/containeranalysis_v1alpha1.projects.notes.occurrences.html b/docs/dyn/containeranalysis_v1alpha1.projects.notes.occurrences.html index 944d97b4ee..e036b1714a 100644 --- a/docs/dyn/containeranalysis_v1alpha1.projects.notes.occurrences.html +++ b/docs/dyn/containeranalysis_v1alpha1.projects.notes.occurrences.html @@ -129,6 +129,13 @@Method Details
"maxSeverity": "A String", # Optional. Tracks max severity found. "modelId": "A String", # Optional. The base name of the model that performed the scan. "scanState": "A String", # Output only. State of the scan. + "tokenUsage": { # Token usage associated with an AI scan. # Output only. Telemetry metrics tracking token usage for the AI scan. + "cacheCount": "A String", # Output only. Cache matched tokens for implicit cache. + "candidateCount": "A String", # Output only. Tokens in the model response. + "promptCount": "A String", # Output only. Tokens in the user request. + "thinkingCount": "A String", # Output only. Tokens in the thinking output. + "toolUsePromptCount": "A String", # Output only. Prompt tokens for using tools. + }, }, "maliciousContentStaticResult": { # Result of Malicious Content Static scan. # Optional. Malicious Content Static scan result. "maxSeverity": "A String", # Optional. Tracks max severity found. diff --git a/docs/dyn/containeranalysis_v1alpha1.projects.occurrences.html b/docs/dyn/containeranalysis_v1alpha1.projects.occurrences.html index 2391ddec62..b453ccd44e 100644 --- a/docs/dyn/containeranalysis_v1alpha1.projects.occurrences.html +++ b/docs/dyn/containeranalysis_v1alpha1.projects.occurrences.html @@ -145,6 +145,13 @@Method Details
"maxSeverity": "A String", # Optional. Tracks max severity found. "modelId": "A String", # Optional. The base name of the model that performed the scan. "scanState": "A String", # Output only. State of the scan. + "tokenUsage": { # Token usage associated with an AI scan. # Output only. Telemetry metrics tracking token usage for the AI scan. + "cacheCount": "A String", # Output only. Cache matched tokens for implicit cache. + "candidateCount": "A String", # Output only. Tokens in the model response. + "promptCount": "A String", # Output only. Tokens in the user request. + "thinkingCount": "A String", # Output only. Tokens in the thinking output. + "toolUsePromptCount": "A String", # Output only. Prompt tokens for using tools. + }, }, "maliciousContentStaticResult": { # Result of Malicious Content Static scan. # Optional. Malicious Content Static scan result. "maxSeverity": "A String", # Optional. Tracks max severity found. @@ -1194,6 +1201,13 @@Method Details
"maxSeverity": "A String", # Optional. Tracks max severity found. "modelId": "A String", # Optional. The base name of the model that performed the scan. "scanState": "A String", # Output only. State of the scan. + "tokenUsage": { # Token usage associated with an AI scan. # Output only. Telemetry metrics tracking token usage for the AI scan. + "cacheCount": "A String", # Output only. Cache matched tokens for implicit cache. + "candidateCount": "A String", # Output only. Tokens in the model response. + "promptCount": "A String", # Output only. Tokens in the user request. + "thinkingCount": "A String", # Output only. Tokens in the thinking output. + "toolUsePromptCount": "A String", # Output only. Prompt tokens for using tools. + }, }, "maliciousContentStaticResult": { # Result of Malicious Content Static scan. # Optional. Malicious Content Static scan result. "maxSeverity": "A String", # Optional. Tracks max severity found. @@ -2267,6 +2281,13 @@Method Details
"maxSeverity": "A String", # Optional. Tracks max severity found. "modelId": "A String", # Optional. The base name of the model that performed the scan. "scanState": "A String", # Output only. State of the scan. + "tokenUsage": { # Token usage associated with an AI scan. # Output only. Telemetry metrics tracking token usage for the AI scan. + "cacheCount": "A String", # Output only. Cache matched tokens for implicit cache. + "candidateCount": "A String", # Output only. Tokens in the model response. + "promptCount": "A String", # Output only. Tokens in the user request. + "thinkingCount": "A String", # Output only. Tokens in the thinking output. + "toolUsePromptCount": "A String", # Output only. Prompt tokens for using tools. + }, }, "maliciousContentStaticResult": { # Result of Malicious Content Static scan. # Optional. Malicious Content Static scan result. "maxSeverity": "A String", # Optional. Tracks max severity found. @@ -3779,6 +3800,13 @@Method Details
"maxSeverity": "A String", # Optional. Tracks max severity found. "modelId": "A String", # Optional. The base name of the model that performed the scan. "scanState": "A String", # Output only. State of the scan. + "tokenUsage": { # Token usage associated with an AI scan. # Output only. Telemetry metrics tracking token usage for the AI scan. + "cacheCount": "A String", # Output only. Cache matched tokens for implicit cache. + "candidateCount": "A String", # Output only. Tokens in the model response. + "promptCount": "A String", # Output only. Tokens in the user request. + "thinkingCount": "A String", # Output only. Tokens in the thinking output. + "toolUsePromptCount": "A String", # Output only. Prompt tokens for using tools. + }, }, "maliciousContentStaticResult": { # Result of Malicious Content Static scan. # Optional. Malicious Content Static scan result. "maxSeverity": "A String", # Optional. Tracks max severity found. @@ -4845,6 +4873,13 @@Method Details
"maxSeverity": "A String", # Optional. Tracks max severity found. "modelId": "A String", # Optional. The base name of the model that performed the scan. "scanState": "A String", # Output only. State of the scan. + "tokenUsage": { # Token usage associated with an AI scan. # Output only. Telemetry metrics tracking token usage for the AI scan. + "cacheCount": "A String", # Output only. Cache matched tokens for implicit cache. + "candidateCount": "A String", # Output only. Tokens in the model response. + "promptCount": "A String", # Output only. Tokens in the user request. + "thinkingCount": "A String", # Output only. Tokens in the thinking output. + "toolUsePromptCount": "A String", # Output only. Prompt tokens for using tools. + }, }, "maliciousContentStaticResult": { # Result of Malicious Content Static scan. # Optional. Malicious Content Static scan result. "maxSeverity": "A String", # Optional. Tracks max severity found. @@ -5894,6 +5929,13 @@Method Details
"maxSeverity": "A String", # Optional. Tracks max severity found. "modelId": "A String", # Optional. The base name of the model that performed the scan. "scanState": "A String", # Output only. State of the scan. + "tokenUsage": { # Token usage associated with an AI scan. # Output only. Telemetry metrics tracking token usage for the AI scan. + "cacheCount": "A String", # Output only. Cache matched tokens for implicit cache. + "candidateCount": "A String", # Output only. Tokens in the model response. + "promptCount": "A String", # Output only. Tokens in the user request. + "thinkingCount": "A String", # Output only. Tokens in the thinking output. + "toolUsePromptCount": "A String", # Output only. Prompt tokens for using tools. + }, }, "maliciousContentStaticResult": { # Result of Malicious Content Static scan. # Optional. Malicious Content Static scan result. "maxSeverity": "A String", # Optional. Tracks max severity found. diff --git a/docs/dyn/containeranalysis_v1alpha1.providers.notes.occurrences.html b/docs/dyn/containeranalysis_v1alpha1.providers.notes.occurrences.html index 439cf44071..c6dbd4670b 100644 --- a/docs/dyn/containeranalysis_v1alpha1.providers.notes.occurrences.html +++ b/docs/dyn/containeranalysis_v1alpha1.providers.notes.occurrences.html @@ -129,6 +129,13 @@Method Details
"maxSeverity": "A String", # Optional. Tracks max severity found. "modelId": "A String", # Optional. The base name of the model that performed the scan. "scanState": "A String", # Output only. State of the scan. + "tokenUsage": { # Token usage associated with an AI scan. # Output only. Telemetry metrics tracking token usage for the AI scan. + "cacheCount": "A String", # Output only. Cache matched tokens for implicit cache. + "candidateCount": "A String", # Output only. Tokens in the model response. + "promptCount": "A String", # Output only. Tokens in the user request. + "thinkingCount": "A String", # Output only. Tokens in the thinking output. + "toolUsePromptCount": "A String", # Output only. Prompt tokens for using tools. + }, }, "maliciousContentStaticResult": { # Result of Malicious Content Static scan. # Optional. Malicious Content Static scan result. "maxSeverity": "A String", # Optional. Tracks max severity found. diff --git a/docs/dyn/containeranalysis_v1beta1.projects.locations.notes.occurrences.html b/docs/dyn/containeranalysis_v1beta1.projects.locations.notes.occurrences.html index b1a6678a54..ebf454af26 100644 --- a/docs/dyn/containeranalysis_v1beta1.projects.locations.notes.occurrences.html +++ b/docs/dyn/containeranalysis_v1beta1.projects.locations.notes.occurrences.html @@ -129,6 +129,13 @@Method Details
"maxSeverity": "A String", # Tracks max severity found. "modelId": "A String", # The base name of the model that performed the scan. "scanStatus": "A String", # Status of the scan. + "tokenUsage": { # Token usage associated with an AI scan. # Telemetry metrics tracking token usage for the AI scan. + "cacheCount": "A String", # Cache matched tokens for implicit cache. + "candidateCount": "A String", # Tokens in the model response. + "promptCount": "A String", # Tokens in the user request. + "thinkingCount": "A String", # Tokens in the thinking output. + "toolUsePromptCount": "A String", # Prompt tokens for using tools. + }, }, "maliciousContentStaticResult": { # Result of Malicious Content Static scan. # Malicious Content Static scan result. "maxSeverity": "A String", # Tracks max severity found. diff --git a/docs/dyn/containeranalysis_v1beta1.projects.locations.occurrences.html b/docs/dyn/containeranalysis_v1beta1.projects.locations.occurrences.html index 8eac833312..9fd615671b 100644 --- a/docs/dyn/containeranalysis_v1beta1.projects.locations.occurrences.html +++ b/docs/dyn/containeranalysis_v1beta1.projects.locations.occurrences.html @@ -145,6 +145,13 @@Method Details
"maxSeverity": "A String", # Tracks max severity found. "modelId": "A String", # The base name of the model that performed the scan. "scanStatus": "A String", # Status of the scan. + "tokenUsage": { # Token usage associated with an AI scan. # Telemetry metrics tracking token usage for the AI scan. + "cacheCount": "A String", # Cache matched tokens for implicit cache. + "candidateCount": "A String", # Tokens in the model response. + "promptCount": "A String", # Tokens in the user request. + "thinkingCount": "A String", # Tokens in the thinking output. + "toolUsePromptCount": "A String", # Prompt tokens for using tools. + }, }, "maliciousContentStaticResult": { # Result of Malicious Content Static scan. # Malicious Content Static scan result. "maxSeverity": "A String", # Tracks max severity found. @@ -830,6 +837,13 @@Method Details
"maxSeverity": "A String", # Tracks max severity found. "modelId": "A String", # The base name of the model that performed the scan. "scanStatus": "A String", # Status of the scan. + "tokenUsage": { # Token usage associated with an AI scan. # Telemetry metrics tracking token usage for the AI scan. + "cacheCount": "A String", # Cache matched tokens for implicit cache. + "candidateCount": "A String", # Tokens in the model response. + "promptCount": "A String", # Tokens in the user request. + "thinkingCount": "A String", # Tokens in the thinking output. + "toolUsePromptCount": "A String", # Prompt tokens for using tools. + }, }, "maliciousContentStaticResult": { # Result of Malicious Content Static scan. # Malicious Content Static scan result. "maxSeverity": "A String", # Tracks max severity found. @@ -1520,6 +1534,13 @@Method Details
"maxSeverity": "A String", # Tracks max severity found. "modelId": "A String", # The base name of the model that performed the scan. "scanStatus": "A String", # Status of the scan. + "tokenUsage": { # Token usage associated with an AI scan. # Telemetry metrics tracking token usage for the AI scan. + "cacheCount": "A String", # Cache matched tokens for implicit cache. + "candidateCount": "A String", # Tokens in the model response. + "promptCount": "A String", # Tokens in the user request. + "thinkingCount": "A String", # Tokens in the thinking output. + "toolUsePromptCount": "A String", # Prompt tokens for using tools. + }, }, "maliciousContentStaticResult": { # Result of Malicious Content Static scan. # Malicious Content Static scan result. "maxSeverity": "A String", # Tracks max severity found. @@ -2201,6 +2222,13 @@Method Details
"maxSeverity": "A String", # Tracks max severity found. "modelId": "A String", # The base name of the model that performed the scan. "scanStatus": "A String", # Status of the scan. + "tokenUsage": { # Token usage associated with an AI scan. # Telemetry metrics tracking token usage for the AI scan. + "cacheCount": "A String", # Cache matched tokens for implicit cache. + "candidateCount": "A String", # Tokens in the model response. + "promptCount": "A String", # Tokens in the user request. + "thinkingCount": "A String", # Tokens in the thinking output. + "toolUsePromptCount": "A String", # Prompt tokens for using tools. + }, }, "maliciousContentStaticResult": { # Result of Malicious Content Static scan. # Malicious Content Static scan result. "maxSeverity": "A String", # Tracks max severity found. @@ -2907,6 +2935,13 @@Method Details
"maxSeverity": "A String", # Tracks max severity found. "modelId": "A String", # The base name of the model that performed the scan. "scanStatus": "A String", # Status of the scan. + "tokenUsage": { # Token usage associated with an AI scan. # Telemetry metrics tracking token usage for the AI scan. + "cacheCount": "A String", # Cache matched tokens for implicit cache. + "candidateCount": "A String", # Tokens in the model response. + "promptCount": "A String", # Tokens in the user request. + "thinkingCount": "A String", # Tokens in the thinking output. + "toolUsePromptCount": "A String", # Prompt tokens for using tools. + }, }, "maliciousContentStaticResult": { # Result of Malicious Content Static scan. # Malicious Content Static scan result. "maxSeverity": "A String", # Tracks max severity found. @@ -4037,6 +4072,13 @@Method Details
"maxSeverity": "A String", # Tracks max severity found. "modelId": "A String", # The base name of the model that performed the scan. "scanStatus": "A String", # Status of the scan. + "tokenUsage": { # Token usage associated with an AI scan. # Telemetry metrics tracking token usage for the AI scan. + "cacheCount": "A String", # Cache matched tokens for implicit cache. + "candidateCount": "A String", # Tokens in the model response. + "promptCount": "A String", # Tokens in the user request. + "thinkingCount": "A String", # Tokens in the thinking output. + "toolUsePromptCount": "A String", # Prompt tokens for using tools. + }, }, "maliciousContentStaticResult": { # Result of Malicious Content Static scan. # Malicious Content Static scan result. "maxSeverity": "A String", # Tracks max severity found. @@ -4739,6 +4781,13 @@Method Details
"maxSeverity": "A String", # Tracks max severity found. "modelId": "A String", # The base name of the model that performed the scan. "scanStatus": "A String", # Status of the scan. + "tokenUsage": { # Token usage associated with an AI scan. # Telemetry metrics tracking token usage for the AI scan. + "cacheCount": "A String", # Cache matched tokens for implicit cache. + "candidateCount": "A String", # Tokens in the model response. + "promptCount": "A String", # Tokens in the user request. + "thinkingCount": "A String", # Tokens in the thinking output. + "toolUsePromptCount": "A String", # Prompt tokens for using tools. + }, }, "maliciousContentStaticResult": { # Result of Malicious Content Static scan. # Malicious Content Static scan result. "maxSeverity": "A String", # Tracks max severity found. @@ -5421,6 +5470,13 @@Method Details
"maxSeverity": "A String", # Tracks max severity found. "modelId": "A String", # The base name of the model that performed the scan. "scanStatus": "A String", # Status of the scan. + "tokenUsage": { # Token usage associated with an AI scan. # Telemetry metrics tracking token usage for the AI scan. + "cacheCount": "A String", # Cache matched tokens for implicit cache. + "candidateCount": "A String", # Tokens in the model response. + "promptCount": "A String", # Tokens in the user request. + "thinkingCount": "A String", # Tokens in the thinking output. + "toolUsePromptCount": "A String", # Prompt tokens for using tools. + }, }, "maliciousContentStaticResult": { # Result of Malicious Content Static scan. # Malicious Content Static scan result. "maxSeverity": "A String", # Tracks max severity found. diff --git a/docs/dyn/containeranalysis_v1beta1.projects.notes.occurrences.html b/docs/dyn/containeranalysis_v1beta1.projects.notes.occurrences.html index a25d342e69..ca29ffe33f 100644 --- a/docs/dyn/containeranalysis_v1beta1.projects.notes.occurrences.html +++ b/docs/dyn/containeranalysis_v1beta1.projects.notes.occurrences.html @@ -129,6 +129,13 @@Method Details
"maxSeverity": "A String", # Tracks max severity found. "modelId": "A String", # The base name of the model that performed the scan. "scanStatus": "A String", # Status of the scan. + "tokenUsage": { # Token usage associated with an AI scan. # Telemetry metrics tracking token usage for the AI scan. + "cacheCount": "A String", # Cache matched tokens for implicit cache. + "candidateCount": "A String", # Tokens in the model response. + "promptCount": "A String", # Tokens in the user request. + "thinkingCount": "A String", # Tokens in the thinking output. + "toolUsePromptCount": "A String", # Prompt tokens for using tools. + }, }, "maliciousContentStaticResult": { # Result of Malicious Content Static scan. # Malicious Content Static scan result. "maxSeverity": "A String", # Tracks max severity found. diff --git a/docs/dyn/containeranalysis_v1beta1.projects.occurrences.html b/docs/dyn/containeranalysis_v1beta1.projects.occurrences.html index d6abb8c4c8..2146f7abf9 100644 --- a/docs/dyn/containeranalysis_v1beta1.projects.occurrences.html +++ b/docs/dyn/containeranalysis_v1beta1.projects.occurrences.html @@ -145,6 +145,13 @@Method Details
"maxSeverity": "A String", # Tracks max severity found. "modelId": "A String", # The base name of the model that performed the scan. "scanStatus": "A String", # Status of the scan. + "tokenUsage": { # Token usage associated with an AI scan. # Telemetry metrics tracking token usage for the AI scan. + "cacheCount": "A String", # Cache matched tokens for implicit cache. + "candidateCount": "A String", # Tokens in the model response. + "promptCount": "A String", # Tokens in the user request. + "thinkingCount": "A String", # Tokens in the thinking output. + "toolUsePromptCount": "A String", # Prompt tokens for using tools. + }, }, "maliciousContentStaticResult": { # Result of Malicious Content Static scan. # Malicious Content Static scan result. "maxSeverity": "A String", # Tracks max severity found. @@ -830,6 +837,13 @@Method Details
"maxSeverity": "A String", # Tracks max severity found. "modelId": "A String", # The base name of the model that performed the scan. "scanStatus": "A String", # Status of the scan. + "tokenUsage": { # Token usage associated with an AI scan. # Telemetry metrics tracking token usage for the AI scan. + "cacheCount": "A String", # Cache matched tokens for implicit cache. + "candidateCount": "A String", # Tokens in the model response. + "promptCount": "A String", # Tokens in the user request. + "thinkingCount": "A String", # Tokens in the thinking output. + "toolUsePromptCount": "A String", # Prompt tokens for using tools. + }, }, "maliciousContentStaticResult": { # Result of Malicious Content Static scan. # Malicious Content Static scan result. "maxSeverity": "A String", # Tracks max severity found. @@ -1520,6 +1534,13 @@Method Details
"maxSeverity": "A String", # Tracks max severity found. "modelId": "A String", # The base name of the model that performed the scan. "scanStatus": "A String", # Status of the scan. + "tokenUsage": { # Token usage associated with an AI scan. # Telemetry metrics tracking token usage for the AI scan. + "cacheCount": "A String", # Cache matched tokens for implicit cache. + "candidateCount": "A String", # Tokens in the model response. + "promptCount": "A String", # Tokens in the user request. + "thinkingCount": "A String", # Tokens in the thinking output. + "toolUsePromptCount": "A String", # Prompt tokens for using tools. + }, }, "maliciousContentStaticResult": { # Result of Malicious Content Static scan. # Malicious Content Static scan result. "maxSeverity": "A String", # Tracks max severity found. @@ -2201,6 +2222,13 @@Method Details
"maxSeverity": "A String", # Tracks max severity found. "modelId": "A String", # The base name of the model that performed the scan. "scanStatus": "A String", # Status of the scan. + "tokenUsage": { # Token usage associated with an AI scan. # Telemetry metrics tracking token usage for the AI scan. + "cacheCount": "A String", # Cache matched tokens for implicit cache. + "candidateCount": "A String", # Tokens in the model response. + "promptCount": "A String", # Tokens in the user request. + "thinkingCount": "A String", # Tokens in the thinking output. + "toolUsePromptCount": "A String", # Prompt tokens for using tools. + }, }, "maliciousContentStaticResult": { # Result of Malicious Content Static scan. # Malicious Content Static scan result. "maxSeverity": "A String", # Tracks max severity found. @@ -2907,6 +2935,13 @@Method Details
"maxSeverity": "A String", # Tracks max severity found. "modelId": "A String", # The base name of the model that performed the scan. "scanStatus": "A String", # Status of the scan. + "tokenUsage": { # Token usage associated with an AI scan. # Telemetry metrics tracking token usage for the AI scan. + "cacheCount": "A String", # Cache matched tokens for implicit cache. + "candidateCount": "A String", # Tokens in the model response. + "promptCount": "A String", # Tokens in the user request. + "thinkingCount": "A String", # Tokens in the thinking output. + "toolUsePromptCount": "A String", # Prompt tokens for using tools. + }, }, "maliciousContentStaticResult": { # Result of Malicious Content Static scan. # Malicious Content Static scan result. "maxSeverity": "A String", # Tracks max severity found. @@ -4037,6 +4072,13 @@Method Details
"maxSeverity": "A String", # Tracks max severity found. "modelId": "A String", # The base name of the model that performed the scan. "scanStatus": "A String", # Status of the scan. + "tokenUsage": { # Token usage associated with an AI scan. # Telemetry metrics tracking token usage for the AI scan. + "cacheCount": "A String", # Cache matched tokens for implicit cache. + "candidateCount": "A String", # Tokens in the model response. + "promptCount": "A String", # Tokens in the user request. + "thinkingCount": "A String", # Tokens in the thinking output. + "toolUsePromptCount": "A String", # Prompt tokens for using tools. + }, }, "maliciousContentStaticResult": { # Result of Malicious Content Static scan. # Malicious Content Static scan result. "maxSeverity": "A String", # Tracks max severity found. @@ -4739,6 +4781,13 @@Method Details
"maxSeverity": "A String", # Tracks max severity found. "modelId": "A String", # The base name of the model that performed the scan. "scanStatus": "A String", # Status of the scan. + "tokenUsage": { # Token usage associated with an AI scan. # Telemetry metrics tracking token usage for the AI scan. + "cacheCount": "A String", # Cache matched tokens for implicit cache. + "candidateCount": "A String", # Tokens in the model response. + "promptCount": "A String", # Tokens in the user request. + "thinkingCount": "A String", # Tokens in the thinking output. + "toolUsePromptCount": "A String", # Prompt tokens for using tools. + }, }, "maliciousContentStaticResult": { # Result of Malicious Content Static scan. # Malicious Content Static scan result. "maxSeverity": "A String", # Tracks max severity found. @@ -5421,6 +5470,13 @@Method Details
"maxSeverity": "A String", # Tracks max severity found. "modelId": "A String", # The base name of the model that performed the scan. "scanStatus": "A String", # Status of the scan. + "tokenUsage": { # Token usage associated with an AI scan. # Telemetry metrics tracking token usage for the AI scan. + "cacheCount": "A String", # Cache matched tokens for implicit cache. + "candidateCount": "A String", # Tokens in the model response. + "promptCount": "A String", # Tokens in the user request. + "thinkingCount": "A String", # Tokens in the thinking output. + "toolUsePromptCount": "A String", # Prompt tokens for using tools. + }, }, "maliciousContentStaticResult": { # Result of Malicious Content Static scan. # Malicious Content Static scan result. "maxSeverity": "A String", # Tracks max severity found. diff --git a/googleapiclient/discovery_cache/documents/containeranalysis.v1.json b/googleapiclient/discovery_cache/documents/containeranalysis.v1.json index 03a579312a..aa31db9ac7 100644 --- a/googleapiclient/discovery_cache/documents/containeranalysis.v1.json +++ b/googleapiclient/discovery_cache/documents/containeranalysis.v1.json @@ -1715,7 +1715,7 @@ } } }, -"revision": "20260819", +"revision": "20260826", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AISkillAnalysisNote": { @@ -5902,6 +5902,10 @@ false "Scan was not performed." ], "type": "string" +}, +"tokenUsage": { +"$ref": "TokenUsage", +"description": "Telemetry metrics tracking token usage for the AI scan." } }, "type": "object" @@ -7379,6 +7383,38 @@ false }, "type": "object" }, +"TokenUsage": { +"description": "Token usage associated with an AI scan.", +"id": "TokenUsage", +"properties": { +"cacheCount": { +"description": "Cache matched tokens for implicit cache.", +"format": "int64", +"type": "string" +}, +"candidateCount": { +"description": "Tokens in the model response.", +"format": "int64", +"type": "string" +}, +"promptCount": { +"description": "Tokens in the user request.", +"format": "int64", +"type": "string" +}, +"thinkingCount": { +"description": "Tokens in the thinking output.", +"format": "int64", +"type": "string" +}, +"toolUsePromptCount": { +"description": "Prompt tokens for using tools.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "UpgradeDistribution": { "description": "The Upgrade Distribution represents metadata about the Upgrade for each operating system (CPE). Some distributions have additional metadata around updates, classifying them into various categories and severities.", "id": "UpgradeDistribution", diff --git a/googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json b/googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json index 0ce650e4e5..43fd7f5160 100644 --- a/googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json @@ -1454,7 +1454,7 @@ } } }, -"revision": "20260819", +"revision": "20260826", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AISkillAnalysisNote": { @@ -5812,6 +5812,11 @@ false ], "readOnly": true, "type": "string" +}, +"tokenUsage": { +"$ref": "TokenUsage", +"description": "Output only. Telemetry metrics tracking token usage for the AI scan.", +"readOnly": true } }, "type": "object" @@ -7753,6 +7758,43 @@ false }, "type": "object" }, +"TokenUsage": { +"description": "Token usage associated with an AI scan.", +"id": "TokenUsage", +"properties": { +"cacheCount": { +"description": "Output only. Cache matched tokens for implicit cache.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"candidateCount": { +"description": "Output only. Tokens in the model response.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"promptCount": { +"description": "Output only. Tokens in the user request.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"thinkingCount": { +"description": "Output only. Tokens in the thinking output.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"toolUsePromptCount": { +"description": "Output only. Prompt tokens for using tools.", +"format": "int64", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "URI": { "description": "An URI message.", "id": "URI", diff --git a/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json b/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json index 299069722f..8b4f47f4f3 100644 --- a/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json @@ -1771,7 +1771,7 @@ } } }, -"revision": "20260819", +"revision": "20260826", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AISkillAnalysisNote": { @@ -6186,6 +6186,10 @@ false "Scan was not performed." ], "type": "string" +}, +"tokenUsage": { +"$ref": "TokenUsage", +"description": "Telemetry metrics tracking token usage for the AI scan." } }, "type": "object" @@ -7782,6 +7786,38 @@ false }, "type": "object" }, +"TokenUsage": { +"description": "Token usage associated with an AI scan.", +"id": "TokenUsage", +"properties": { +"cacheCount": { +"description": "Cache matched tokens for implicit cache.", +"format": "int64", +"type": "string" +}, +"candidateCount": { +"description": "Tokens in the model response.", +"format": "int64", +"type": "string" +}, +"promptCount": { +"description": "Tokens in the user request.", +"format": "int64", +"type": "string" +}, +"thinkingCount": { +"description": "Tokens in the thinking output.", +"format": "int64", +"type": "string" +}, +"toolUsePromptCount": { +"description": "Prompt tokens for using tools.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "Version": { "description": "Version contains structured information about the version of a package.", "id": "Version", From 312b6cbb39fbdc676488a7c63a8f52a899154711 Mon Sep 17 00:00:00 2001 From: Yoshi AutomationDate: Tue, 8 Sep 2026 07:20:14 +0000 Subject: [PATCH 18/40] feat(dataflow): update the api #### dataflow:v1b3 The following keys were added: - resources.projects.resources.jobs.methods.aggregated.parameters.regionalFanoutRequested (Total Keys: 2) - resources.projects.resources.jobs.methods.list.parameters.regionalFanoutRequested (Total Keys: 2) - resources.projects.resources.locations.resources.jobs.methods.list.parameters.regionalFanoutRequested (Total Keys: 2) --- docs/dyn/dataflow_v1b3.projects.jobs.html | 10 ++++++---- .../dataflow_v1b3.projects.locations.jobs.html | 5 +++-- .../documents/dataflow.v1b3.json | 17 ++++++++++++++++- 3 files changed, 25 insertions(+), 7 deletions(-) diff --git a/docs/dyn/dataflow_v1b3.projects.jobs.html b/docs/dyn/dataflow_v1b3.projects.jobs.html index 82596122ec..69deae4215 100644 --- a/docs/dyn/dataflow_v1b3.projects.jobs.html +++ b/docs/dyn/dataflow_v1b3.projects.jobs.html @@ -90,7 +90,7 @@ Instance Methods
Returns the workItems Resource.
+aggregated(projectId, filter=None, location=None, name=None, pageSize=None, pageToken=None, regionalFanoutRequested=None, view=None, x__xgafv=None)List the jobs of a project across all regions. **Note:** This method doesn't support filtering the list of jobs by name. # IAM Permissions Requires the `dataflow.jobs.list` permission on the project.
@@ -108,7 +108,7 @@
aggregated_next(previous_request, previous_response)Instance Methods
getMetrics(projectId, jobId, location=None, startTime=None, x__xgafv=None)Request the job status. To request the status of a job, we recommend using `projects.locations.jobs.getMetrics` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.getMetrics` is not recommended, as you can only request the status of jobs that are running in `us-central1`. # IAM Permissions Requires the `dataflow.metrics.get` permission on the job.
+list(projectId, filter=None, location=None, name=None, pageSize=None, pageToken=None, regionalFanoutRequested=None, view=None, x__xgafv=None)List the jobs of a project. To list the jobs of a project in a region, we recommend using `projects.locations.jobs.list` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). To list the all jobs across all regions, use `projects.jobs.aggregated`. Using `projects.jobs.list` is not recommended, because you can only get the list of jobs that are running in `us-central1`. `projects.locations.jobs.list` and `projects.jobs.list` support filtering the list of jobs by name. Filtering by name isn't supported by `projects.jobs.aggregated`. # IAM Permissions Requires the `dataflow.jobs.list` permission on the project.
@@ -121,7 +121,7 @@
list_next(previous_request, previous_response)Instance Methods
Updates the state of an existing Cloud Dataflow job. To update the state of an existing job, we recommend using `projects.locations.jobs.update` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.update` is not recommended, as you can only update the state of jobs that are running in `us-central1`. # IAM Permissions 1. Requires the `dataflow.jobs.cancel` permission to cancel a job. 2. Requires the `dataflow.jobs.updateContents` permission to update runtime parameters.
Method Details
-aggregated(projectId, filter=None, location=None, name=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)+aggregated(projectId, filter=None, location=None, name=None, pageSize=None, pageToken=None, regionalFanoutRequested=None, view=None, x__xgafv=None)List the jobs of a project across all regions. **Note:** This method doesn't support filtering the list of jobs by name. # IAM Permissions Requires the `dataflow.jobs.list` permission on the project. Args: @@ -136,6 +136,7 @@Method Details
name: string, Optional. The job name. pageSize: integer, If there are many jobs, limit response to at most this many. The actual number of jobs returned will be the lesser of max_responses and an unspecified server-defined limit. pageToken: string, Set this to the 'next_page_token' field of a previous response to request additional results in a long list. + regionalFanoutRequested: boolean, Optional. view: string, Deprecated. ListJobs always returns summaries now. Use GetJob for other JobViews. Allowed values JOB_VIEW_UNKNOWN - The job view to return isn't specified, or is unknown. Responses will contain at least the `JOB_VIEW_SUMMARY` information, and may contain additional information. @@ -1687,7 +1688,7 @@Method Details
-list(projectId, filter=None, location=None, name=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)+list(projectId, filter=None, location=None, name=None, pageSize=None, pageToken=None, regionalFanoutRequested=None, view=None, x__xgafv=None)List the jobs of a project. To list the jobs of a project in a region, we recommend using `projects.locations.jobs.list` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). To list the all jobs across all regions, use `projects.jobs.aggregated`. Using `projects.jobs.list` is not recommended, because you can only get the list of jobs that are running in `us-central1`. `projects.locations.jobs.list` and `projects.jobs.list` support filtering the list of jobs by name. Filtering by name isn't supported by `projects.jobs.aggregated`. # IAM Permissions Requires the `dataflow.jobs.list` permission on the project. Args: @@ -1702,6 +1703,7 @@Method Details
name: string, Optional. The job name. pageSize: integer, If there are many jobs, limit response to at most this many. The actual number of jobs returned will be the lesser of max_responses and an unspecified server-defined limit. pageToken: string, Set this to the 'next_page_token' field of a previous response to request additional results in a long list. + regionalFanoutRequested: boolean, Optional. view: string, Deprecated. ListJobs always returns summaries now. Use GetJob for other JobViews. Allowed values JOB_VIEW_UNKNOWN - The job view to return isn't specified, or is unknown. Responses will contain at least the `JOB_VIEW_SUMMARY` information, and may contain additional information. diff --git a/docs/dyn/dataflow_v1b3.projects.locations.jobs.html b/docs/dyn/dataflow_v1b3.projects.locations.jobs.html index c29d61c05c..a6d7fa0b5f 100644 --- a/docs/dyn/dataflow_v1b3.projects.locations.jobs.html +++ b/docs/dyn/dataflow_v1b3.projects.locations.jobs.html @@ -118,7 +118,7 @@Instance Methods
getMetrics(projectId, location, jobId, startTime=None, x__xgafv=None)Request the job status. To request the status of a job, we recommend using `projects.locations.jobs.getMetrics` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.getMetrics` is not recommended, as you can only request the status of jobs that are running in `us-central1`. # IAM Permissions Requires the `dataflow.metrics.get` permission on the job.
+list(projectId, location, filter=None, name=None, pageSize=None, pageToken=None, regionalFanoutRequested=None, view=None, x__xgafv=None)List the jobs of a project. To list the jobs of a project in a region, we recommend using `projects.locations.jobs.list` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). To list the all jobs across all regions, use `projects.jobs.aggregated`. Using `projects.jobs.list` is not recommended, because you can only get the list of jobs that are running in `us-central1`. `projects.locations.jobs.list` and `projects.jobs.list` support filtering the list of jobs by name. Filtering by name isn't supported by `projects.jobs.aggregated`. # IAM Permissions Requires the `dataflow.jobs.list` permission on the project.
@@ -1399,7 +1399,7 @@
list_next(previous_request, previous_response)Method Details
-+list(projectId, location, filter=None, name=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)+list(projectId, location, filter=None, name=None, pageSize=None, pageToken=None, regionalFanoutRequested=None, view=None, x__xgafv=None)List the jobs of a project. To list the jobs of a project in a region, we recommend using `projects.locations.jobs.list` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). To list the all jobs across all regions, use `projects.jobs.aggregated`. Using `projects.jobs.list` is not recommended, because you can only get the list of jobs that are running in `us-central1`. `projects.locations.jobs.list` and `projects.jobs.list` support filtering the list of jobs by name. Filtering by name isn't supported by `projects.jobs.aggregated`. # IAM Permissions Requires the `dataflow.jobs.list` permission on the project. Args: @@ -1414,6 +1414,7 @@Method Details
name: string, Optional. The job name. pageSize: integer, If there are many jobs, limit response to at most this many. The actual number of jobs returned will be the lesser of max_responses and an unspecified server-defined limit. pageToken: string, Set this to the 'next_page_token' field of a previous response to request additional results in a long list. + regionalFanoutRequested: boolean, Optional. view: string, Deprecated. ListJobs always returns summaries now. Use GetJob for other JobViews. Allowed values JOB_VIEW_UNKNOWN - The job view to return isn't specified, or is unknown. Responses will contain at least the `JOB_VIEW_SUMMARY` information, and may contain additional information. diff --git a/googleapiclient/discovery_cache/documents/dataflow.v1b3.json b/googleapiclient/discovery_cache/documents/dataflow.v1b3.json index 67b8cad5e3..085dfdd9b1 100644 --- a/googleapiclient/discovery_cache/documents/dataflow.v1b3.json +++ b/googleapiclient/discovery_cache/documents/dataflow.v1b3.json @@ -790,6 +790,11 @@ "required": true, "type": "string" }, +"regionalFanoutRequested": { +"description": "Optional.", +"location": "query", +"type": "boolean" +}, "view": { "deprecated": true, "description": "Deprecated. ListJobs always returns summaries now. Use GetJob for other JobViews.", @@ -1023,6 +1028,11 @@ "required": true, "type": "string" }, +"regionalFanoutRequested": { +"description": "Optional.", +"location": "query", +"type": "boolean" +}, "view": { "deprecated": true, "description": "Deprecated. ListJobs always returns summaries now. Use GetJob for other JobViews.", @@ -1868,6 +1878,11 @@ "required": true, "type": "string" }, +"regionalFanoutRequested": { +"description": "Optional.", +"location": "query", +"type": "boolean" +}, "view": { "deprecated": true, "description": "Deprecated. ListJobs always returns summaries now. Use GetJob for other JobViews.", @@ -2884,7 +2899,7 @@ } } }, -"revision": "20260818", +"revision": "20260825", "rootUrl": "https://dataflow.googleapis.com/", "schemas": { "ApproximateProgress": { From 7b885849516dc1073088c7bb4293f5dd54686b5d Mon Sep 17 00:00:00 2001 From: Yoshi AutomationDate: Tue, 8 Sep 2026 07:20:14 +0000 Subject: [PATCH 19/40] feat(dataproc): update the api #### dataproc:v1 The following keys were added: - schemas.AttachedDiskConfig.properties.diskType.deprecated (Total Keys: 1) - schemas.AttachedDiskConfig.properties.type.type (Total Keys: 1) --- ....projects.locations.workflowTemplates.html | 168 ++++++++++++------ ...dataproc_v1.projects.regions.clusters.html | 96 ++++++---- ....projects.regions.clusters.nodeGroups.html | 12 +- ...v1.projects.regions.workflowTemplates.html | 168 ++++++++++++------ .../documents/dataproc.v1.json | 19 +- 5 files changed, 308 insertions(+), 155 deletions(-) diff --git a/docs/dyn/dataproc_v1.projects.locations.workflowTemplates.html b/docs/dyn/dataproc_v1.projects.locations.workflowTemplates.html index 44ce26bb75..c92267f58e 100644 --- a/docs/dyn/dataproc_v1.projects.locations.workflowTemplates.html +++ b/docs/dyn/dataproc_v1.projects.locations.workflowTemplates.html @@ -421,9 +421,10 @@ Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -444,9 +445,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -639,9 +641,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -662,9 +665,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -731,9 +735,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -754,9 +759,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -855,9 +861,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -878,9 +885,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -1247,9 +1255,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -1270,9 +1279,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -1465,9 +1475,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -1488,9 +1499,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -1557,9 +1569,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -1580,9 +1593,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -1681,9 +1695,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -1704,9 +1719,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -2100,9 +2116,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -2123,9 +2140,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -2318,9 +2336,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -2341,9 +2360,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -2410,9 +2430,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -2433,9 +2454,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -2534,9 +2556,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -2557,9 +2580,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -3017,9 +3041,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -3040,9 +3065,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -3235,9 +3261,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -3258,9 +3285,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -3327,9 +3355,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -3350,9 +3379,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -3451,9 +3481,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -3474,9 +3505,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -3884,9 +3916,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -3907,9 +3940,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -4102,9 +4136,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -4125,9 +4160,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -4194,9 +4230,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -4217,9 +4254,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -4318,9 +4356,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -4341,9 +4380,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -4819,9 +4859,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -4842,9 +4883,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -5037,9 +5079,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -5060,9 +5103,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -5129,9 +5173,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -5152,9 +5197,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -5253,9 +5299,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -5276,9 +5323,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -5645,9 +5693,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -5668,9 +5717,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -5863,9 +5913,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -5886,9 +5937,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -5955,9 +6007,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -5978,9 +6031,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -6079,9 +6133,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -6102,9 +6157,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. diff --git a/docs/dyn/dataproc_v1.projects.regions.clusters.html b/docs/dyn/dataproc_v1.projects.regions.clusters.html index 409ab3728a..32a0571d07 100644 --- a/docs/dyn/dataproc_v1.projects.regions.clusters.html +++ b/docs/dyn/dataproc_v1.projects.regions.clusters.html @@ -165,9 +165,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -188,9 +189,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -383,9 +385,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -406,9 +409,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -475,9 +479,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -498,9 +503,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -599,9 +605,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -622,9 +629,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -941,9 +949,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -964,9 +973,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -1159,9 +1169,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -1182,9 +1193,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -1251,9 +1263,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -1274,9 +1287,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -1375,9 +1389,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -1398,9 +1413,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -1678,9 +1694,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -1701,9 +1718,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -1896,9 +1914,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -1919,9 +1938,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -1988,9 +2008,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -2011,9 +2032,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -2112,9 +2134,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -2135,9 +2158,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -2335,9 +2359,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -2358,9 +2383,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -2553,9 +2579,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -2576,9 +2603,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -2645,9 +2673,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -2668,9 +2697,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -2769,9 +2799,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -2792,9 +2823,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. diff --git a/docs/dyn/dataproc_v1.projects.regions.clusters.nodeGroups.html b/docs/dyn/dataproc_v1.projects.regions.clusters.nodeGroups.html index 0a15361a2f..38fce697c9 100644 --- a/docs/dyn/dataproc_v1.projects.regions.clusters.nodeGroups.html +++ b/docs/dyn/dataproc_v1.projects.regions.clusters.nodeGroups.html @@ -120,9 +120,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -143,9 +144,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -265,9 +267,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -288,9 +291,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. diff --git a/docs/dyn/dataproc_v1.projects.regions.workflowTemplates.html b/docs/dyn/dataproc_v1.projects.regions.workflowTemplates.html index 3c0ea32e96..c279b7ee5f 100644 --- a/docs/dyn/dataproc_v1.projects.regions.workflowTemplates.html +++ b/docs/dyn/dataproc_v1.projects.regions.workflowTemplates.html @@ -421,9 +421,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -444,9 +445,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -639,9 +641,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -662,9 +665,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -731,9 +735,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -754,9 +759,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -855,9 +861,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -878,9 +885,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -1247,9 +1255,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -1270,9 +1279,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -1465,9 +1475,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -1488,9 +1499,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -1557,9 +1569,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -1580,9 +1593,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -1681,9 +1695,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -1704,9 +1719,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -2100,9 +2116,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -2123,9 +2140,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -2318,9 +2336,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -2341,9 +2360,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -2410,9 +2430,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -2433,9 +2454,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -2534,9 +2556,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -2557,9 +2580,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -3017,9 +3041,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -3040,9 +3065,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -3235,9 +3261,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -3258,9 +3285,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -3327,9 +3355,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -3350,9 +3379,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -3451,9 +3481,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -3474,9 +3505,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -3884,9 +3916,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -3907,9 +3940,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -4102,9 +4136,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -4125,9 +4160,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -4194,9 +4230,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -4217,9 +4254,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -4318,9 +4356,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -4341,9 +4380,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -4819,9 +4859,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -4842,9 +4883,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -5037,9 +5079,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -5060,9 +5103,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -5129,9 +5173,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -5152,9 +5197,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -5253,9 +5299,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -5276,9 +5323,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -5645,9 +5693,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -5668,9 +5717,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -5863,9 +5913,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -5886,9 +5937,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -5955,9 +6007,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -5978,9 +6031,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -6079,9 +6133,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. @@ -6102,9 +6157,10 @@Method Details
"attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances. { # Specifies the config of attached disk options for single VM instance. "diskSizeGb": 42, # Optional. Disk size in GB. - "diskType": "A String", # Optional. Disk type. + "diskType": "A String", # Optional. Deprecated: Use type instead. "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features + "type": "A String", # Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput }, ], "bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. diff --git a/googleapiclient/discovery_cache/documents/dataproc.v1.json b/googleapiclient/discovery_cache/documents/dataproc.v1.json index 3a2d4408c9..01f12dbec6 100644 --- a/googleapiclient/discovery_cache/documents/dataproc.v1.json +++ b/googleapiclient/discovery_cache/documents/dataproc.v1.json @@ -5498,7 +5498,7 @@ } } }, -"revision": "20260818", +"revision": "20260820", "rootUrl": "https://dataproc.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -5983,7 +5983,8 @@ "type": "integer" }, "diskType": { -"description": "Optional. Disk type.", +"deprecated": true, +"description": "Optional. Deprecated: Use type instead.", "enum": [ "DISK_TYPE_UNSPECIFIED", "HYPERDISK_BALANCED", @@ -5992,11 +5993,11 @@ "HYPERDISK_THROUGHPUT" ], "enumDescriptions": [ -"Required unspecified disk type.", -"Hyperdisk Balanced disk type.", -"Hyperdisk Extreme disk type.", -"Hyperdisk ML disk type.", -"Hyperdisk Throughput disk type." +"Disk type is not specified.", +"Hyperdisk Balanced.", +"Hyperdisk Extreme.", +"Hyperdisk ML.", +"Hyperdisk Throughput." ], "type": "string" }, @@ -6009,6 +6010,10 @@ "description": "Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features", "format": "int64", "type": "string" +}, +"type": { +"description": "Optional. Attached disk type. Currently only supports Hyperdisks. See https://cloud.google.com/compute/docs/disks/hyperdisks. Note: Hyperdisk Balanced High Availability is not supported.Allowed values are: hyperdisk-balanced hyperdisk-extreme hyperdisk-ml hyperdisk-throughput", +"type": "string" } }, "type": "object" From 778de5aaf64877399c599c33b4f7a092d3ba113e Mon Sep 17 00:00:00 2001 From: Yoshi AutomationDate: Tue, 8 Sep 2026 07:20:14 +0000 Subject: [PATCH 20/40] feat(discoveryengine): update the api #### discoveryengine:v1 The following keys were added: - resources.projects.resources.locations.resources.collections.methods.getIamPolicy (Total Keys: 14) - resources.projects.resources.locations.resources.collections.methods.setIamPolicy (Total Keys: 12) - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.getIamPolicy (Total Keys: 14) - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.setIamPolicy (Total Keys: 12) - resources.projects.resources.locations.resources.dataStores.methods.getIamPolicy (Total Keys: 14) - resources.projects.resources.locations.resources.dataStores.methods.setIamPolicy (Total Keys: 12) - schemas.GoogleCloudDiscoveryengineV1SearchRequest.properties.searchAddonSpec.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1SearchRequestSearchAddonSpec (Total Keys: 5) - schemas.GoogleCloudDiscoveryengineV1WidgetConfigCustomerProvidedConfig.properties.complianceLevel (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1WidgetConfigUiSettings.properties.searchAddonSpec.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsSearchAddonSpec (Total Keys: 5) #### discoveryengine:v1alpha The following keys were added: - schemas.GoogleCloudDiscoveryengineV1alphaAssistant.properties.knowledgeCatalogEnabled.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigCustomerProvidedConfig.properties.complianceLevel (Total Keys: 2) #### discoveryengine:v1beta The following keys were added: - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.getIamPolicy (Total Keys: 14) - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.setIamPolicy (Total Keys: 12) - resources.projects.resources.locations.resources.dataStores.methods.getIamPolicy (Total Keys: 14) - resources.projects.resources.locations.resources.dataStores.methods.setIamPolicy (Total Keys: 12) --- ...ects.locations.collections.dataStores.html | 99 +++++++ ...collections.dataStores.servingConfigs.html | 10 + ....collections.dataStores.widgetConfigs.html | 24 +- ...rojects.locations.collections.engines.html | 10 +- ...ns.collections.engines.servingConfigs.html | 10 + ...ons.collections.engines.widgetConfigs.html | 24 +- ...ine_v1.projects.locations.collections.html | 99 +++++++ ...gine_v1.projects.locations.dataStores.html | 99 +++++++ ...s.locations.dataStores.servingConfigs.html | 10 + ...ts.locations.dataStores.widgetConfigs.html | 24 +- ....collections.dataStores.widgetConfigs.html | 9 +- ...ations.collections.engines.assistants.html | 6 + ...rojects.locations.collections.engines.html | 14 +- ...ons.collections.engines.widgetConfigs.html | 9 +- ...ts.locations.dataStores.widgetConfigs.html | 9 +- ...ects.locations.collections.dataStores.html | 99 +++++++ ...rojects.locations.collections.engines.html | 14 +- ..._v1beta.projects.locations.dataStores.html | 99 +++++++ .../documents/discoveryengine.v1.json | 262 +++++++++++++++++- .../documents/discoveryengine.v1alpha.json | 31 ++- .../documents/discoveryengine.v1beta.json | 134 ++++++++- 21 files changed, 1044 insertions(+), 51 deletions(-) diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html index 5bf3935bdb..36f68cc1d1 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html @@ -164,6 +164,9 @@ Instance Methods
Gets a DataStore.
++
+getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)Gets the IAM access control policy for a DataStore. A `NOT_FOUND` error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.
getSiteSearchEngine(name, x__xgafv=None)Gets the SiteSearchEngine.
@@ -176,6 +179,9 @@Instance Methods
patch(name, body=None, updateMask=None, x__xgafv=None)Updates a DataStore
++
+setIamPolicy(resource, body=None, x__xgafv=None)Sets the IAM access control policy for a DataStore. A `NOT_FOUND` error is returned if the resource does not exist. **Important:** When setting a policy directly on a DataStore resource, the only recommended roles in the bindings are: `roles/discoveryengine.admin` `roles/discoveryengine.agentspaceAdmin` `roles/discoveryengine.viewer` `roles/discoveryengine.agentspaceViewer` `roles/discoveryengine.user` `roles/discoveryengine.agentspaceUser` Attempting to grant any other role will result in a warning in logging.
trainCustomModel(dataStore, body=None, x__xgafv=None)Trains a custom model.
@@ -633,6 +639,41 @@Method Details
}++getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)+Gets the IAM access control policy for a DataStore. A `NOT_FOUND` error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it. + +Args: + resource: string, REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required) + options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). + "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. + { # Associates `members`, or principals, with a `role`. + "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. + "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + }, + "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + "A String", + ], + "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). + }, + ], + "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. + "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). +}++getSiteSearchEngine(name, x__xgafv=None)Gets the SiteSearchEngine. @@ -1194,6 +1235,64 @@Method Details
}++setIamPolicy(resource, body=None, x__xgafv=None)+Sets the IAM access control policy for a DataStore. A `NOT_FOUND` error is returned if the resource does not exist. **Important:** When setting a policy directly on a DataStore resource, the only recommended roles in the bindings are: `roles/discoveryengine.admin` `roles/discoveryengine.agentspaceAdmin` `roles/discoveryengine.viewer` `roles/discoveryengine.agentspaceViewer` `roles/discoveryengine.user` `roles/discoveryengine.agentspaceUser` Attempting to grant any other role will result in a warning in logging. + +Args: + resource: string, REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required) + body: object, The request body. + The object takes the form of: + +{ # Request message for `SetIamPolicy` method. + "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them. + "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. + { # Associates `members`, or principals, with a `role`. + "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. + "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + }, + "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + "A String", + ], + "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). + }, + ], + "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. + "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + }, +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). + "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. + { # Associates `members`, or principals, with a `role`. + "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. + "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + }, + "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + "A String", + ], + "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). + }, + ], + "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. + "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). +}++trainCustomModel(dataStore, body=None, x__xgafv=None)Trains a custom model. 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 25ca2cf511..4270512c53 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html @@ -1813,6 +1813,11 @@Method Details
}, "relevanceThreshold": "A String", # The global relevance threshold of the search results. Defaults to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. If more granular relevance filtering is required, use the `relevance_filter_spec` instead. 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. 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. + }, "searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, @@ -2301,6 +2306,11 @@Method Details
}, "relevanceThreshold": "A String", # The global relevance threshold of the search results. Defaults to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. If more granular relevance filtering is required, use the `relevance_filter_spec` instead. 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. 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. + }, "searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.widgetConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.widgetConfigs.html index 8616fba950..6fd63e3a8f 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.widgetConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.widgetConfigs.html @@ -214,6 +214,7 @@Method Details
}, "createTime": "A String", # Output only. Timestamp the WidgetConfig was created. "customerProvidedConfig": { # Customer provided configurations. # Optional. Output only. Describes the customer related configurations, currently only used for government customers. This field cannot be modified after project onboarding. + "complianceLevel": "A String", # Output only. The customer's Assured Workloads compliance level. `customer_type` collapses every compliance level into a single `GOVERNMENT_CUSTOMER` value, so a client that gates a feature on one specific level rather than on government status as a whole must read this field instead. "customerType": "A String", # Customer type. }, "dataStoreType": "A String", # Output only. The type of the parent data store. @@ -333,7 +334,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` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` + "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` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -376,6 +377,11 @@Method Details
}, "onedrivePickerEnabled": True or False, # Output only. Whether the OneDrive file picker is available to end-users. Computed by the backend from admin connector enablement (Business edition) or attached OneDrive connectors (Enterprise edition), combined with the existing `disable-onedrive-upload` admin feature. Declared `optional` so an explicitly-computed `false` is serialized with field presence. A plain proto3 `bool` drops a default `false` on the wire, which prevented clients from distinguishing "picker disabled" (`false`) from "field not populated" (unset). "resultDescriptionType": "A String", # Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified. + "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search. By default, if this field is not specified, add-ons are enabled wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search. This field is only supported for search requests. + "generativeAnswerAddOnDisabled": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers. + "kpiPersonalizationAddOnDisabled": True or False, # Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results. + "semanticAddOnDisabled": True or False, # Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream. + }, "sourceAdminDisplayNameEnabled": True or False, # Optional. Whether to show the admin-configured display name for data connectors in the widget sources UI (instead of the connector kind). Opt-in; defaults to false. }, "updateTime": "A String", # Output only. Timestamp the WidgetConfig was updated. @@ -494,6 +500,7 @@Method Details
}, "createTime": "A String", # Output only. Timestamp the WidgetConfig was created. "customerProvidedConfig": { # Customer provided configurations. # Optional. Output only. Describes the customer related configurations, currently only used for government customers. This field cannot be modified after project onboarding. + "complianceLevel": "A String", # Output only. The customer's Assured Workloads compliance level. `customer_type` collapses every compliance level into a single `GOVERNMENT_CUSTOMER` value, so a client that gates a feature on one specific level rather than on government status as a whole must read this field instead. "customerType": "A String", # Customer type. }, "dataStoreType": "A String", # Output only. The type of the parent data store. @@ -613,7 +620,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` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` + "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` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -656,6 +663,11 @@Method Details
}, "onedrivePickerEnabled": True or False, # Output only. Whether the OneDrive file picker is available to end-users. Computed by the backend from admin connector enablement (Business edition) or attached OneDrive connectors (Enterprise edition), combined with the existing `disable-onedrive-upload` admin feature. Declared `optional` so an explicitly-computed `false` is serialized with field presence. A plain proto3 `bool` drops a default `false` on the wire, which prevented clients from distinguishing "picker disabled" (`false`) from "field not populated" (unset). "resultDescriptionType": "A String", # Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified. + "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search. By default, if this field is not specified, add-ons are enabled wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search. This field is only supported for search requests. + "generativeAnswerAddOnDisabled": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers. + "kpiPersonalizationAddOnDisabled": True or False, # Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results. + "semanticAddOnDisabled": True or False, # Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream. + }, "sourceAdminDisplayNameEnabled": True or False, # Optional. Whether to show the admin-configured display name for data connectors in the widget sources UI (instead of the connector kind). Opt-in; defaults to false. }, "updateTime": "A String", # Output only. Timestamp the WidgetConfig was updated. @@ -773,6 +785,7 @@Method Details
}, "createTime": "A String", # Output only. Timestamp the WidgetConfig was created. "customerProvidedConfig": { # Customer provided configurations. # Optional. Output only. Describes the customer related configurations, currently only used for government customers. This field cannot be modified after project onboarding. + "complianceLevel": "A String", # Output only. The customer's Assured Workloads compliance level. `customer_type` collapses every compliance level into a single `GOVERNMENT_CUSTOMER` value, so a client that gates a feature on one specific level rather than on government status as a whole must read this field instead. "customerType": "A String", # Customer type. }, "dataStoreType": "A String", # Output only. The type of the parent data store. @@ -892,7 +905,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` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` + "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` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -935,6 +948,11 @@Method Details
}, "onedrivePickerEnabled": True or False, # Output only. Whether the OneDrive file picker is available to end-users. Computed by the backend from admin connector enablement (Business edition) or attached OneDrive connectors (Enterprise edition), combined with the existing `disable-onedrive-upload` admin feature. Declared `optional` so an explicitly-computed `false` is serialized with field presence. A plain proto3 `bool` drops a default `false` on the wire, which prevented clients from distinguishing "picker disabled" (`false`) from "field not populated" (unset). "resultDescriptionType": "A String", # Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified. + "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search. By default, if this field is not specified, add-ons are enabled wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search. This field is only supported for search requests. + "generativeAnswerAddOnDisabled": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers. + "kpiPersonalizationAddOnDisabled": True or False, # Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results. + "semanticAddOnDisabled": True or False, # Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream. + }, "sourceAdminDisplayNameEnabled": True or False, # Optional. Whether to show the admin-configured display name for data connectors in the widget sources UI (instead of the connector kind). Opt-in; defaults to false. }, "updateTime": "A String", # Output only. Timestamp the WidgetConfig was updated. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html index 872d790ddf..b8bc4fba15 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html @@ -204,7 +204,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` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` + "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` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` "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. @@ -391,7 +391,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` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` + "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` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` "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. @@ -554,7 +554,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` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` + "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` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` "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. @@ -689,7 +689,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` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` + "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` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` "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. @@ -806,7 +806,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` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` + "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` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` "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.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html index efffeb70e6..f94a46f7dd 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html @@ -1813,6 +1813,11 @@Method Details
}, "relevanceThreshold": "A String", # The global relevance threshold of the search results. Defaults to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. If more granular relevance filtering is required, use the `relevance_filter_spec` instead. 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. 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. + }, "searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, @@ -2301,6 +2306,11 @@Method Details
}, "relevanceThreshold": "A String", # The global relevance threshold of the search results. Defaults to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. If more granular relevance filtering is required, use the `relevance_filter_spec` instead. 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. 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. + }, "searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.widgetConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.widgetConfigs.html index 2b5379f739..af07086ee7 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.widgetConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.widgetConfigs.html @@ -214,6 +214,7 @@Method Details
}, "createTime": "A String", # Output only. Timestamp the WidgetConfig was created. "customerProvidedConfig": { # Customer provided configurations. # Optional. Output only. Describes the customer related configurations, currently only used for government customers. This field cannot be modified after project onboarding. + "complianceLevel": "A String", # Output only. The customer's Assured Workloads compliance level. `customer_type` collapses every compliance level into a single `GOVERNMENT_CUSTOMER` value, so a client that gates a feature on one specific level rather than on government status as a whole must read this field instead. "customerType": "A String", # Customer type. }, "dataStoreType": "A String", # Output only. The type of the parent data store. @@ -333,7 +334,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` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` + "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` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -376,6 +377,11 @@Method Details
}, "onedrivePickerEnabled": True or False, # Output only. Whether the OneDrive file picker is available to end-users. Computed by the backend from admin connector enablement (Business edition) or attached OneDrive connectors (Enterprise edition), combined with the existing `disable-onedrive-upload` admin feature. Declared `optional` so an explicitly-computed `false` is serialized with field presence. A plain proto3 `bool` drops a default `false` on the wire, which prevented clients from distinguishing "picker disabled" (`false`) from "field not populated" (unset). "resultDescriptionType": "A String", # Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified. + "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search. By default, if this field is not specified, add-ons are enabled wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search. This field is only supported for search requests. + "generativeAnswerAddOnDisabled": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers. + "kpiPersonalizationAddOnDisabled": True or False, # Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results. + "semanticAddOnDisabled": True or False, # Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream. + }, "sourceAdminDisplayNameEnabled": True or False, # Optional. Whether to show the admin-configured display name for data connectors in the widget sources UI (instead of the connector kind). Opt-in; defaults to false. }, "updateTime": "A String", # Output only. Timestamp the WidgetConfig was updated. @@ -494,6 +500,7 @@Method Details
}, "createTime": "A String", # Output only. Timestamp the WidgetConfig was created. "customerProvidedConfig": { # Customer provided configurations. # Optional. Output only. Describes the customer related configurations, currently only used for government customers. This field cannot be modified after project onboarding. + "complianceLevel": "A String", # Output only. The customer's Assured Workloads compliance level. `customer_type` collapses every compliance level into a single `GOVERNMENT_CUSTOMER` value, so a client that gates a feature on one specific level rather than on government status as a whole must read this field instead. "customerType": "A String", # Customer type. }, "dataStoreType": "A String", # Output only. The type of the parent data store. @@ -613,7 +620,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` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` + "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` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -656,6 +663,11 @@Method Details
}, "onedrivePickerEnabled": True or False, # Output only. Whether the OneDrive file picker is available to end-users. Computed by the backend from admin connector enablement (Business edition) or attached OneDrive connectors (Enterprise edition), combined with the existing `disable-onedrive-upload` admin feature. Declared `optional` so an explicitly-computed `false` is serialized with field presence. A plain proto3 `bool` drops a default `false` on the wire, which prevented clients from distinguishing "picker disabled" (`false`) from "field not populated" (unset). "resultDescriptionType": "A String", # Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified. + "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search. By default, if this field is not specified, add-ons are enabled wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search. This field is only supported for search requests. + "generativeAnswerAddOnDisabled": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers. + "kpiPersonalizationAddOnDisabled": True or False, # Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results. + "semanticAddOnDisabled": True or False, # Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream. + }, "sourceAdminDisplayNameEnabled": True or False, # Optional. Whether to show the admin-configured display name for data connectors in the widget sources UI (instead of the connector kind). Opt-in; defaults to false. }, "updateTime": "A String", # Output only. Timestamp the WidgetConfig was updated. @@ -773,6 +785,7 @@Method Details
}, "createTime": "A String", # Output only. Timestamp the WidgetConfig was created. "customerProvidedConfig": { # Customer provided configurations. # Optional. Output only. Describes the customer related configurations, currently only used for government customers. This field cannot be modified after project onboarding. + "complianceLevel": "A String", # Output only. The customer's Assured Workloads compliance level. `customer_type` collapses every compliance level into a single `GOVERNMENT_CUSTOMER` value, so a client that gates a feature on one specific level rather than on government status as a whole must read this field instead. "customerType": "A String", # Customer type. }, "dataStoreType": "A String", # Output only. The type of the parent data store. @@ -892,7 +905,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` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` + "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` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -935,6 +948,11 @@Method Details
}, "onedrivePickerEnabled": True or False, # Output only. Whether the OneDrive file picker is available to end-users. Computed by the backend from admin connector enablement (Business edition) or attached OneDrive connectors (Enterprise edition), combined with the existing `disable-onedrive-upload` admin feature. Declared `optional` so an explicitly-computed `false` is serialized with field presence. A plain proto3 `bool` drops a default `false` on the wire, which prevented clients from distinguishing "picker disabled" (`false`) from "field not populated" (unset). "resultDescriptionType": "A String", # Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified. + "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search. By default, if this field is not specified, add-ons are enabled wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search. This field is only supported for search requests. + "generativeAnswerAddOnDisabled": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers. + "kpiPersonalizationAddOnDisabled": True or False, # Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results. + "semanticAddOnDisabled": True or False, # Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream. + }, "sourceAdminDisplayNameEnabled": True or False, # Optional. Whether to show the admin-configured display name for data connectors in the widget sources UI (instead of the connector kind). Opt-in; defaults to false. }, "updateTime": "A String", # Output only. Timestamp the WidgetConfig was updated. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.html index 2131c1c91a..51ba144f8b 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.html @@ -103,6 +103,12 @@Instance Methods
getDataConnector(name, x__xgafv=None)Gets the DataConnector. DataConnector is a singleton resource for each Collection.
++
+getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)Gets the IAM access control policy for a Collection. A `NOT_FOUND` error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.
++
+setIamPolicy(resource, body=None, x__xgafv=None)Sets the IAM access control policy for a Collection. A `NOT_FOUND` error is returned if the resource does not exist. **Important:** When setting a policy directly on a Collection resource, the only recommended roles in the bindings are: `roles/discoveryengine.admin` `roles/discoveryengine.agentspaceAdmin` `roles/discoveryengine.viewer` `roles/discoveryengine.agentspaceViewer` `roles/discoveryengine.user` `roles/discoveryengine.agentspaceUser` Attempting to grant any other role will result in a warning in logging.
updateDataConnector(name, body=None, updateMask=None, x__xgafv=None)Updates a DataConnector.
@@ -399,6 +405,99 @@Method Details
}++ +getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)+Gets the IAM access control policy for a Collection. A `NOT_FOUND` error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it. + +Args: + resource: string, REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required) + options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). + "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. + { # Associates `members`, or principals, with a `role`. + "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. + "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + }, + "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + "A String", + ], + "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). + }, + ], + "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. + "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). +}+++setIamPolicy(resource, body=None, x__xgafv=None)+Sets the IAM access control policy for a Collection. A `NOT_FOUND` error is returned if the resource does not exist. **Important:** When setting a policy directly on a Collection resource, the only recommended roles in the bindings are: `roles/discoveryengine.admin` `roles/discoveryengine.agentspaceAdmin` `roles/discoveryengine.viewer` `roles/discoveryengine.agentspaceViewer` `roles/discoveryengine.user` `roles/discoveryengine.agentspaceUser` Attempting to grant any other role will result in a warning in logging. + +Args: + resource: string, REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required) + body: object, The request body. + The object takes the form of: + +{ # Request message for `SetIamPolicy` method. + "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them. + "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. + { # Associates `members`, or principals, with a `role`. + "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. + "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + }, + "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + "A String", + ], + "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). + }, + ], + "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. + "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + }, +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). + "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. + { # Associates `members`, or principals, with a `role`. + "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. + "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + }, + "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + "A String", + ], + "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). + }, + ], + "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. + "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). +}+updateDataConnector(name, body=None, updateMask=None, x__xgafv=None)Updates a DataConnector. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html index bc69e8841b..cf56da7b4a 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html @@ -159,6 +159,9 @@Instance Methods
Gets a DataStore.
++
+getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)Gets the IAM access control policy for a DataStore. A `NOT_FOUND` error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.
getSiteSearchEngine(name, x__xgafv=None)Gets the SiteSearchEngine.
@@ -171,6 +174,9 @@Instance Methods
patch(name, body=None, updateMask=None, x__xgafv=None)Updates a DataStore
++
+setIamPolicy(resource, body=None, x__xgafv=None)Sets the IAM access control policy for a DataStore. A `NOT_FOUND` error is returned if the resource does not exist. **Important:** When setting a policy directly on a DataStore resource, the only recommended roles in the bindings are: `roles/discoveryengine.admin` `roles/discoveryengine.agentspaceAdmin` `roles/discoveryengine.viewer` `roles/discoveryengine.agentspaceViewer` `roles/discoveryengine.user` `roles/discoveryengine.agentspaceUser` Attempting to grant any other role will result in a warning in logging.
Method Details
+close()@@ -625,6 +631,41 @@Method Details
}++getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)+Gets the IAM access control policy for a DataStore. A `NOT_FOUND` error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it. + +Args: + resource: string, REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required) + options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). + "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. + { # Associates `members`, or principals, with a `role`. + "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. + "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + }, + "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + "A String", + ], + "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). + }, + ], + "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. + "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). +}++getSiteSearchEngine(name, x__xgafv=None)Gets the SiteSearchEngine. @@ -1186,4 +1227,62 @@Method Details
}++setIamPolicy(resource, body=None, x__xgafv=None)+Sets the IAM access control policy for a DataStore. A `NOT_FOUND` error is returned if the resource does not exist. **Important:** When setting a policy directly on a DataStore resource, the only recommended roles in the bindings are: `roles/discoveryengine.admin` `roles/discoveryengine.agentspaceAdmin` `roles/discoveryengine.viewer` `roles/discoveryengine.agentspaceViewer` `roles/discoveryengine.user` `roles/discoveryengine.agentspaceUser` Attempting to grant any other role will result in a warning in logging. + +Args: + resource: string, REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required) + body: object, The request body. + The object takes the form of: + +{ # Request message for `SetIamPolicy` method. + "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them. + "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. + { # Associates `members`, or principals, with a `role`. + "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. + "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + }, + "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + "A String", + ], + "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). + }, + ], + "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. + "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + }, +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). + "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. + { # Associates `members`, or principals, with a `role`. + "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. + "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + }, + "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + "A String", + ], + "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). + }, + ], + "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. + "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). +}+